java.lang.Object

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

すべての実装されたインタフェース:: DocTreeVisitor<R,P>

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

public class DocTreeScanner<R,P> extends Object implements DocTreeVisitor<R,P>

すべての子ツリー・ノードにアクセスするDocTreeVisitor。特定の型のノードを巡回するには、対応するvisitXYZメソッドを単にオーバーライドします。独自のメソッド内では、super.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);
      }
   }

実装要件:

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

ビジットされているノードに子がない場合、結果はnullになります。
ビジットされているノードに1つの子がある場合、その子でscanをコールした結果になります。子は、単一のノードでも、ノードのリストでもかまいません。
ビジットされているノードに複数の子がある場合、scanを各子に順番にコールし、reduce(R, R)メソッドによって決定される累積結果と最初のスキャン後の各スキャン結果を組み合せることで結果が決定されます。各子は、単純なノードまたはノードのリストのいずれかです。 reduceメソッドのデフォルトの動作では、visitXYZメソッドの結果は、最後にスキャンされた子の結果になります。

導入されたバージョン:

1.8

コンストラクタのサマリー

コンストラクタ

コンストラクタ

説明

DocTreeScanner()

DocTreeScannerを構築します。
メソッドのサマリー

修飾子と型

メソッド

説明

R

reduce(R r1, R r2)

2つの結果を1つの結合された結果にします。

R

scan(DocTree node, P p)

1つのノードをスキャンします。

R

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

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

R

visitAttribute(AttributeTree node, P p)

AttributeTreeノードにビジットします。

R

visitAuthor(AuthorTree node, P p)

AuthorTreeノードにビジットします。

R

visitComment(CommentTree node, P p)

CommentTreeノードにビジットします。

R

visitDeprecated(DeprecatedTree node, P p)

DeprecatedTreeノードにビジットします。

R

visitDocComment(DocCommentTree node, P p)

DocCommentTreeノードにビジットします。

R

visitDocRoot(DocRootTree node, P p)

DocRootTreeノードにビジットします。

R

visitDocType(DocTypeTree node, P p)

DocTypeTreeノードにビジットします。

R

visitEndElement(EndElementTree node, P p)

EndElementTreeノードにビジットします。

R

visitEntity(EntityTree node, P p)

EntityTreeノードにビジットします。

R

visitErroneous(ErroneousTree node, P p)

ErroneousTreeノードにビジットします。

R

visitHidden(HiddenTree node, P p)

HiddenTreeノードにビジットします。

R

visitIdentifier(IdentifierTree node, P p)

IdentifierTreeノードにビジットします。

R

visitIndex(IndexTree node, P p)

IndexTreeノードにビジットします。

R

visitInheritDoc(InheritDocTree node, P p)

InheritDocTreeノードにビジットします。

R

visitLink(LinkTree node, P p)

LinkTreeノードにビジットします。

R

visitLiteral(LiteralTree node, P p)

LiteralTreeノードにビジットします。

R

visitOther(DocTree node, P p)

不明なタイプのDocTreeノードにビジットします。

R

visitParam(ParamTree node, P p)

ParamTreeノードにビジットします。

R

visitProvides(ProvidesTree node, P p)

ProvidesTreeノードにビジットします。

R

visitReference(ReferenceTree node, P p)

ReferenceTreeノードにビジットします。

R

visitReturn(ReturnTree node, P p)

ReturnTreeノードにビジットします。

R

visitSee(SeeTree node, P p)

SeeTreeノードにビジットします。

R

visitSerial(SerialTree node, P p)

SerialTreeノードにビジットします。

R

visitSerialData(SerialDataTree node, P p)

SerialDataTreeノードにビジットします。

R

visitSerialField(SerialFieldTree node, P p)

SerialFieldTreeノードにビジットします。

R

visitSince(SinceTree node, P p)

SinceTreeノードにビジットします。

R

visitSnippet(SnippetTree node, P p)

SnippetTreeノードにビジットします。

R

visitStartElement(StartElementTree node, P p)

StartElementTreeノードにビジットします。

R

visitSummary(SummaryTree node, P p)

SummaryTreeノードにビジットします。

R

visitSystemProperty(SystemPropertyTree node, P p)

SystemPropertyTreeノードにビジットします。

R

visitText(TextTree node, P p)

TextTreeノードにビジットします。

R

visitThrows(ThrowsTree node, P p)

ThrowsTreeノードにビジットします。

R

visitUnknownBlockTag(UnknownBlockTagTree node, P p)

UnknownBlockTagTreeノードにビジットします。

R

visitUnknownInlineTag(UnknownInlineTagTree node, P p)

UnknownInlineTagTreeノードにビジットします。

R

visitUses(UsesTree node, P p)

UsesTreeノードにビジットします。

R

visitValue(ValueTree node, P p)

ValueTreeノードにビジットします。

R

visitVersion(VersionTree node, P p)

VersionTreeノードにビジットします。

クラス java.lang.Objectで宣言されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細
- DocTreeScanner
  
  public DocTreeScanner()
  
  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ノードにビジットします。
  
  定義:
  
  インタフェース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ノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitComment
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  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ノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitDocRoot
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitDocType
  
  public R visitDocType(DocTypeTree node, P p)
  
  DocTypeTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitDocType
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitEndElement
  
  public R visitEndElement(EndElementTree node, P p)
  
  EndElementTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitEndElement
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitEntity
  
  public R visitEntity(EntityTree node, P p)
  
  EntityTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitEntity
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitErroneous
  
  public R visitErroneous(ErroneousTree node, P p)
  
  ErroneousTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitErroneous
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  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ノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitIdentifier
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitIndex
  
  public R visitIndex(IndexTree node, P p)
  
  IndexTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitIndex
  
  実装要件:
  
  この実装は、左から右の順序で子をスキャンします。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitInheritDoc
  
  public R visitInheritDoc(InheritDocTree node, P p)
  
  InheritDocTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitInheritDoc
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  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ノードにビジットします。
  
  定義:
  
  インタフェース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ノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitReference
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  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 - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitSnippet
  
  public R visitSnippet(SnippetTree node, P p)
  
  SnippetTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitSnippet
  
  実装要件:
  
  この実装は、左から右の順序で子をスキャンします。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
  
  導入されたバージョン:
  
  18
- 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
- visitSystemProperty
  
  public R visitSystemProperty(SystemPropertyTree node, P p)
  
  SystemPropertyTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitSystemProperty
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
  
  導入されたバージョン:
  
  12
- visitText
  
  public R visitText(TextTree node, P p)
  
  TextTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitText
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  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)
  
  VersionTreeノードにビジットします。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitVersion
  
  実装要件:
  
  この実装は、左から右の順序で子をスキャンします。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果
- visitOther
  
  public R visitOther(DocTree node, P p)
  
  不明なタイプのDocTreeノードにビジットします。これは、タグのセットが進化し、新しい種類のノードがDocTree階層に追加された場合に発生します。
  
  定義:
  
  インタフェースDocTreeVisitor<R,P>内のvisitOther
  
  実装要件:
  
  この実装ではnullが返されます。
  
  パラメータ:
  
  node - ビジットされているノード
  
  p - パラメータ値
  
  戻り値:
  
  スキャン結果

クラスDocTreeScanner<R,P>

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Objectで宣言されたメソッド

コンストラクタの詳細

DocTreeScanner

メソッドの詳細

scan

scan

reduce

visitAttribute

visitAuthor

visitComment

visitDeprecated

visitDocComment

visitDocRoot

visitDocType

visitEndElement

visitEntity

visitErroneous

visitHidden

visitIdentifier

visitIndex

visitInheritDoc

visitLink

visitLiteral

visitParam

visitProvides

visitReference

visitReturn

visitSee

visitSerial

visitSerialData

visitSerialField

visitSince

visitSnippet

visitStartElement

visitSummary

visitSystemProperty

visitText

visitThrows

visitUnknownBlockTag

visitUnknownInlineTag

visitUses

visitValue

visitVersion

visitOther