モジュール jdk.compiler
パッケージ com.sun.source.util

クラスDocTreeScanner<R,​P>

  • すべての実装されたインタフェース:
    DocTreeVisitor<R,​P>
    直系の既知のサブクラス:
    DocTreePathScanner

    public class DocTreeScanner<R,​P>
    extends Object
    implements DocTreeVisitor<R,​P>
    すべての子ツリー・ノードを巡回するTreeVisitorです。 特定の型のノードを巡回するには、対応するvisitXYZメソッドを単にオーバーライドします。 独自のメソッド内では、super.visitXYZを呼び出して、下位ノードを巡回します。

    visitXYZメソッドのデフォルトの実装では、次の結果になります。

    • ビジットしているノードに子がない場合、結果はnullになります。
    • 巡回対象のノードが1つの子を持つ場合、その子でscanを呼び出した結果と同じになります。 子は、単一のノードでも、ノードのリストでもかまいません。
    • 巡回対象のノードが複数の子を持つ場合、それぞれの子で順番にscanを呼び出し、2番目以降の各スキャンの結果を、それまでの累積的な結果と結合することで結果が得られます。これは、reduce(R, R)メソッドによる結果と同様です。 それぞれの子は、単一のノードでも、ノードのリストでもかまいません。 reduceメソッドのデフォルトの動作では、visitXYZメソッドの結果は、最後にスキャンされた子の結果になります。

    ツリー内のエラー・ノードの数をカウントする例を次に示します。

       class CountErrors extends DocTreeScanner<Integer,Void> {
          @Override
          public Integer visitErroneous(ErroneousTree node, Void p) {
              return 1;
          }
          @Override
          public Integer reduce(Integer r1, Integer r2) {
              return (r1 == null ? 0 : r1) + (r2 == null ? 0 : r2);
          }
       }
     

    導入されたバージョン:
    1.8
    • コンストラクタの詳細

      • DocTreeScanner

        public DocTreeScanner()
    • メソッドの詳細

      • scan

        public R scan​(DocTree node,
                      P p)
        1つのノードをスキャンします。
        パラメータ:
        node - スキャンするノード
        p - メソッドに渡されるパラメータ値
        戻り値:
        メソッドの結果値
      • scan

        public R scan​(Iterable<? extends DocTree> nodes,
                      P p)
        一連のノードをスキャンします。
        パラメータ:
        nodes - スキャンするノード
        p - 各ノードのメソッドに渡すパラメータ値
        戻り値:
        メソッドからの戻り値の組み合わせ。 値は、reduceメソッドを使用して結合されます。
      • reduce

        public R reduce​(R r1,
                        R r2)
        2つの結果を1つの結合された結果にします。 デフォルトの実装では、1番目のパラメータを返します。 メソッドの一般的な規約によれば、メソッドはどのようなアクションを実行してもかまいません。
        パラメータ:
        r1 - 結合される最初の値
        r2 - 結合される値の2番目の値
        戻り値:
        2つのパラメータを組み合わせた結果
      • visitAttribute

        public R visitAttribute​(AttributeTree node,
                                P p)
        AttributeTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitAttribute
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitAuthor

        public R visitAuthor​(AuthorTree node,
                             P p)
        AuthorTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitAuthor
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitComment

        public R visitComment​(CommentTree node,
                              P p)
        CommentTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitComment
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitDeprecated

        public R visitDeprecated​(DeprecatedTree node,
                                 P p)
        DeprecatedTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitDeprecated
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitDocComment

        public R visitDocComment​(DocCommentTree node,
                                 P p)
        DocCommentTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitDocComment
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitDocRoot

        public R visitDocRoot​(DocRootTree node,
                              P p)
        DocRootTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitDocRoot
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitDocType

        public R visitDocType​(DocTypeTree node,
                              P p)
        DocTypeTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitDocType
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitEndElement

        public R visitEndElement​(EndElementTree node,
                                 P p)
        EndElementTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitEndElement
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitEntity

        public R visitEntity​(EntityTree node,
                             P p)
        EntityTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitEntity
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitErroneous

        public R visitErroneous​(ErroneousTree node,
                                P p)
        ErroneousTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitErroneous
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitHidden

        public R visitHidden​(HiddenTree node,
                             P p)
        HiddenTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitHidden
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitIdentifier

        public R visitIdentifier​(IdentifierTree node,
                                 P p)
        IdentifierTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitIdentifier
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitIndex

        public R visitIndex​(IndexTree node,
                            P p)
        IndexTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitIndex
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitInheritDoc

        public R visitInheritDoc​(InheritDocTree node,
                                 P p)
        InheritDocTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitInheritDoc
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitLink

        public R visitLink​(LinkTree node,
                           P p)
        LinkTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitLink
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitLiteral

        public R visitLiteral​(LiteralTree node,
                              P p)
        LiteralTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitLiteral
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitParam

        public R visitParam​(ParamTree node,
                            P p)
        ParamTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitParam
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitProvides

        public R visitProvides​(ProvidesTree node,
                               P p)
        ProvidesTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitProvides
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitReference

        public R visitReference​(ReferenceTree node,
                                P p)
        ReferenceTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitReference
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitReturn

        public R visitReturn​(ReturnTree node,
                             P p)
        ReturnTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitReturn
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitSee

        public R visitSee​(SeeTree node,
                          P p)
        SeeTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitSee
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitSerial

        public R visitSerial​(SerialTree node,
                             P p)
        SerialTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitSerial
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitSerialData

        public R visitSerialData​(SerialDataTree node,
                                 P p)
        SerialDataTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitSerialData
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitSerialField

        public R visitSerialField​(SerialFieldTree node,
                                  P p)
        SerialFieldTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitSerialField
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitSince

        public R visitSince​(SinceTree node,
                            P p)
        SinceTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitSince
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitStartElement

        public R visitStartElement​(StartElementTree node,
                                   P p)
        StartElementTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitStartElement
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitSummary

        public R visitSummary​(SummaryTree node,
                              P p)
        SummaryTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitSummary
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
        導入されたバージョン:
        10
      • visitText

        public R visitText​(TextTree node,
                           P p)
        TextTreeノードをビジットします。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitText
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitThrows

        public R visitThrows​(ThrowsTree node,
                             P p)
        ThrowsTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitThrows
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitUnknownBlockTag

        public R visitUnknownBlockTag​(UnknownBlockTagTree node,
                                      P p)
        UnknownBlockTagTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitUnknownBlockTag
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitUnknownInlineTag

        public R visitUnknownInlineTag​(UnknownInlineTagTree node,
                                       P p)
        UnknownInlineTagTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitUnknownInlineTag
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitUses

        public R visitUses​(UsesTree node,
                           P p)
        UsesTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitUses
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitValue

        public R visitValue​(ValueTree node,
                            P p)
        ValueTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitValue
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitVersion

        public R visitVersion​(VersionTree node,
                              P p)
        VersionTreeTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitVersion
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果
      • visitOther

        public R visitOther​(DocTree node,
                            P p)
        未知の型のDocTreeノードをビジットします。 これは、タグのセットが進化し、新しい種類のノードがDocTree階層に追加された場合に発生します。 この実装ではnullが返されます。
        定義:
        インタフェースDocTreeVisitor<R,​P>内のvisitOther
        パラメータ:
        node - ビジットされたノード
        p - パラメータ値
        戻り値:
        スキャン結果