com.sun.source.util

クラスDocTreeScanner<R,P>

java.lang.Object

com.sun.source.util.DocTreeScanner<R,P>

すべての実装されたインタフェース:

DocTreeVisitor<R,P>

直系の既知のサブクラス:

DocTreePathScanner

@Exported
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()

メソッドのサマリー

修飾子と型	メソッドと説明
R	reduce(R r1, R r2) 2つの結果を1つの結合された結果にします。
R	scan(DocTree node, P p) 単一ノードをスキャンします。
R	scan(Iterable<? extends DocTree> nodes, P p) ノードのリストをスキャンします。
R	visitAttribute(AttributeTree node, P p)
R	visitAuthor(AuthorTree node, P p)
R	visitComment(CommentTree node, P p)
R	visitDeprecated(DeprecatedTree node, P p)
R	visitDocComment(DocCommentTree node, P p)
R	visitDocRoot(DocRootTree node, P p)
R	visitEndElement(EndElementTree node, P p)
R	visitEntity(EntityTree node, P p)
R	visitErroneous(ErroneousTree node, P p)
R	visitIdentifier(IdentifierTree node, P p)
R	visitInheritDoc(InheritDocTree node, P p)
R	visitLink(LinkTree node, P p)
R	visitLiteral(LiteralTree node, P p)
R	visitOther(DocTree node, P p)
R	visitParam(ParamTree node, P p)
R	visitReference(ReferenceTree node, P p)
R	visitReturn(ReturnTree node, P p)
R	visitSee(SeeTree node, P p)
R	visitSerial(SerialTree node, P p)
R	visitSerialData(SerialDataTree node, P p)
R	visitSerialField(SerialFieldTree node, P p)
R	visitSince(SinceTree node, P p)
R	visitStartElement(StartElementTree node, P p)
R	visitText(TextTree node, P p)
R	visitThrows(ThrowsTree node, P p)
R	visitUnknownBlockTag(UnknownBlockTagTree node, P p)
R	visitUnknownInlineTag(UnknownInlineTagTree node, P p)
R	visitValue(ValueTree node, P p)
R	visitVersion(VersionTree node, P p)

クラス java.lang.Objectから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

DocTreeScanner

public DocTreeScanner()

メソッドの詳細

scan

public R scan(DocTree node,
              P p)

単一ノードをスキャンします。

scan

public R scan(Iterable<? extends DocTree> nodes,
              P p)

ノードのリストをスキャンします。

reduce

public R reduce(R r1,
                R r2)

2つの結果を1つの結合された結果にします。デフォルトの実装では、1番目のパラメータを返します。メソッドの一般的な規約によれば、メソッドはどのようなアクションを実行してもかまいません。

visitAttribute

public R visitAttribute(AttributeTree node,
                        P p)

定義:

visitAttribute、インタフェース: DocTreeVisitor<R,P>

visitAuthor

public R visitAuthor(AuthorTree node,
                     P p)

定義:

visitAuthor、インタフェース: DocTreeVisitor<R,P>

visitComment

public R visitComment(CommentTree node,
                      P p)

定義:

visitComment、インタフェース: DocTreeVisitor<R,P>

visitDeprecated

public R visitDeprecated(DeprecatedTree node,
                         P p)

定義:

visitDeprecated、インタフェース: DocTreeVisitor<R,P>

visitDocComment

public R visitDocComment(DocCommentTree node,
                         P p)

定義:

visitDocComment、インタフェース: DocTreeVisitor<R,P>

visitDocRoot

public R visitDocRoot(DocRootTree node,
                      P p)

定義:

visitDocRoot、インタフェース: DocTreeVisitor<R,P>

visitEndElement

public R visitEndElement(EndElementTree node,
                         P p)

定義:

visitEndElement、インタフェース: DocTreeVisitor<R,P>

visitEntity

public R visitEntity(EntityTree node,
                     P p)

定義:

visitEntity、インタフェース: DocTreeVisitor<R,P>

visitErroneous

public R visitErroneous(ErroneousTree node,
                        P p)

定義:

visitErroneous、インタフェース: DocTreeVisitor<R,P>

visitIdentifier

public R visitIdentifier(IdentifierTree node,
                         P p)

定義:

visitIdentifier、インタフェース: DocTreeVisitor<R,P>

visitInheritDoc

public R visitInheritDoc(InheritDocTree node,
                         P p)

定義:

visitInheritDoc、インタフェース: DocTreeVisitor<R,P>

visitLink

public R visitLink(LinkTree node,
                   P p)

定義:

visitLink、インタフェース: DocTreeVisitor<R,P>

visitLiteral

public R visitLiteral(LiteralTree node,
                      P p)

定義:

visitLiteral、インタフェース: DocTreeVisitor<R,P>

visitParam

public R visitParam(ParamTree node,
                    P p)

定義:

visitParam、インタフェース: DocTreeVisitor<R,P>

visitReference

public R visitReference(ReferenceTree node,
                        P p)

定義:

visitReference、インタフェース: DocTreeVisitor<R,P>

visitReturn

public R visitReturn(ReturnTree node,
                     P p)

定義:

visitReturn、インタフェース: DocTreeVisitor<R,P>

visitSee

public R visitSee(SeeTree node,
                  P p)

定義:

visitSee、インタフェース: DocTreeVisitor<R,P>

visitSerial

public R visitSerial(SerialTree node,
                     P p)

定義:

visitSerial、インタフェース: DocTreeVisitor<R,P>

visitSerialData

public R visitSerialData(SerialDataTree node,
                         P p)

定義:

visitSerialData、インタフェース: DocTreeVisitor<R,P>

visitSerialField

public R visitSerialField(SerialFieldTree node,
                          P p)

定義:

visitSerialField、インタフェース: DocTreeVisitor<R,P>

visitSince

public R visitSince(SinceTree node,
                    P p)

定義:

visitSince、インタフェース: DocTreeVisitor<R,P>

visitStartElement

public R visitStartElement(StartElementTree node,
                           P p)

定義:

visitStartElement、インタフェース: DocTreeVisitor<R,P>

visitText

public R visitText(TextTree node,
                   P p)

定義:

visitText、インタフェース: DocTreeVisitor<R,P>

visitThrows

public R visitThrows(ThrowsTree node,
                     P p)

定義:

visitThrows、インタフェース: DocTreeVisitor<R,P>

visitUnknownBlockTag

public R visitUnknownBlockTag(UnknownBlockTagTree node,
                              P p)

定義:

visitUnknownBlockTag、インタフェース: DocTreeVisitor<R,P>

visitUnknownInlineTag

public R visitUnknownInlineTag(UnknownInlineTagTree node,
                               P p)

定義:

visitUnknownInlineTag、インタフェース: DocTreeVisitor<R,P>

visitValue

public R visitValue(ValueTree node,
                    P p)

定義:

visitValue、インタフェース: DocTreeVisitor<R,P>

visitVersion

public R visitVersion(VersionTree node,
                      P p)

定義:

visitVersion、インタフェース: DocTreeVisitor<R,P>

visitOther

public R visitOther(DocTree node,
                    P p)

定義:

visitOther、インタフェース: DocTreeVisitor<R,P>