java.lang.Object
com.sun.source.util.DocTreeScanner<R,P>
- すべての実装されたインタフェース:
DocTreeVisitor<R,P>
- 直系の既知のサブクラス:
DocTreePathScanner
public classDocTreeScanner<R,P> extends Object implements DocTreeVisitor<R,P>
すべての子ツリー・ノードにアクセスするDocTreeVisitor。 特定の型のノードを巡回するには、対応する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
-
コンストラクタのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明2つの結果を1つの結合された結果にします。1つのノードをスキャンします。一連のノードをスキャンします。visitAttribute(AttributeTree node, P p)
AttributeTreeノードをビジットします。visitAuthor(AuthorTree node, P p)
AuthorTreeノードをビジットします。visitComment(CommentTree node, P p)
CommentTreeノードをビジットします。visitDeprecated(DeprecatedTree node, P p)
DeprecatedTreeノードをビジットします。visitDocComment(DocCommentTree node, P p)
DocCommentTreeノードをビジットします。visitDocRoot(DocRootTree node, P p)
DocRootTreeノードをビジットします。visitDocType(DocTypeTree node, P p)
DocTypeTreeノードをビジットします。visitEndElement(EndElementTree node, P p)
EndElementTreeノードをビジットします。visitEntity(EntityTree node, P p)
EntityTreeノードをビジットします。visitErroneous(ErroneousTree node, P p)
ErroneousTreeノードをビジットします。visitHidden(HiddenTree node, P p)
HiddenTreeノードをビジットします。visitIdentifier(IdentifierTree node, P p)
IdentifierTreeノードをビジットします。visitIndex(IndexTree node, P p)
IndexTreeノードをビジットします。visitInheritDoc(InheritDocTree node, P p)
InheritDocTreeノードをビジットします。LinkTreeノードをビジットします。visitLiteral(LiteralTree node, P p)
LiteralTreeノードをビジットします。visitOther(DocTree node, P p)
未知の型のDocTreeノードをビジットします。visitParam(ParamTree node, P p)
ParamTreeノードをビジットします。visitProvides(ProvidesTree node, P p)
ProvidesTreeノードをビジットします。visitReference(ReferenceTree node, P p)
ReferenceTreeノードをビジットします。visitReturn(ReturnTree node, P p)
ReturnTreeノードをビジットします。SeeTreeノードをビジットします。visitSerial(SerialTree node, P p)
SerialTreeノードをビジットします。visitSerialData(SerialDataTree node, P p)
SerialDataTreeノードをビジットします。visitSerialField(SerialFieldTree node, P p)
SerialFieldTreeノードをビジットします。visitSince(SinceTree node, P p)
SinceTreeノードをビジットします。visitStartElement(StartElementTree node, P p)
StartElementTreeノードをビジットします。visitSummary(SummaryTree node, P p)
SummaryTreeノードをビジットします。visitSystemProperty(SystemPropertyTree node, P p)
SystemPropertyTreeノードにアクセスします。TextTreeノードをビジットします。visitThrows(ThrowsTree node, P p)
ThrowsTreeノードをビジットします。visitUnknownBlockTag(UnknownBlockTagTree node, P p)
UnknownBlockTagTreeノードをビジットします。visitUnknownInlineTag(UnknownInlineTagTree node, P p)
UnknownInlineTagTreeノードをビジットします。UsesTreeノードをビジットします。visitValue(ValueTree node, P p)
ValueTreeノードをビジットします。visitVersion(VersionTree node, P p)
VersionTreeノードにアクセスします。
-
コンストラクタの詳細
-
DocTreeScanner
public DocTreeScanner()DocTreeScanner
を構築します。
-
-
メソッドの詳細
-
scan
1つのノードをスキャンします。- パラメータ:
node
- スキャンするノードp
- メソッドに渡されるパラメータ値- 戻り値:
- メソッドの結果値
-
scan
一連のノードをスキャンします。- パラメータ:
nodes
- スキャンするノードp
- 各ノードのメソッドに渡すパラメータ値- 戻り値:
- メソッドからの戻り値の組み合わせ。 値は、
reduce
メソッドを使用して結合されます。
-
reduce
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ノードをビジットします。 この実装では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
IndexTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitIndex
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitInheritDoc
public R visitInheritDoc(InheritDocTree node, P p)InheritDocTreeノードをビジットします。 この実装ではnull
が返されます。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitInheritDoc
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitLink
LinkTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitLink
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitLiteral
public R visitLiteral(LiteralTree node, P p)LiteralTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitLiteral
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitParam
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
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
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
-
visitSystemProperty
public R visitSystemProperty(SystemPropertyTree node, P p)SystemPropertyTreeノードにアクセスします。 この実装ではnull
が返されます。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitSystemProperty
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
- 導入されたバージョン:
- 12
-
visitText
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
UsesTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitUses
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitValue
ValueTreeノードをビジットします。 この実装は、左から右の順序で子をスキャンします。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitValue
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitVersion
public R visitVersion(VersionTree node, P p)VersionTreeノードにアクセスします。 この実装は、左から右の順序で子をスキャンします。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitVersion
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitOther
未知の型のDocTreeノードをビジットします。 これは、タグのセットが進化し、新しい種類のノードがDocTree
階層に追加された場合に発生します。 この実装ではnull
が返されます。- 定義:
- インタフェース
DocTreeVisitor<R,P>
内のvisitOther
- パラメータ:
node
- ビジットされたノードp
- パラメータ値- 戻り値:
- スキャン結果
-