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
-
コンストラクタのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明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
ノードにビジットします。visitSnippet
(SnippetTree node, P p) SnippetTree
ノードにビジットします。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
ノードにビジットします。- 定義:
- インタフェース
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
IndexTree
ノードにビジットします。- 定義:
- インタフェース
DocTreeVisitor<R,
内のP> visitIndex
- 実装要件:
- この実装は、左から右の順序で子をスキャンします。
- パラメータ:
node
- ビジットされているノードp
- パラメータ値- 戻り値:
- スキャン結果
-
visitInheritDoc
public R visitInheritDoc(InheritDocTree node, P p) InheritDocTree
ノードにビジットします。- 定義:
- インタフェース
DocTreeVisitor<R,
内のP> visitInheritDoc
- 実装要件:
- この実装では
null
が返されます。 - パラメータ:
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
ノードにビジットします。- 定義:
- インタフェース
DocTreeVisitor<R,
内のP> visitReference
- 実装要件:
- この実装では
null
が返されます。 - パラメータ:
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
- パラメータ値- 戻り値:
- スキャン結果
-
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
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
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
階層に追加された場合に発生します。- 定義:
- インタフェース
DocTreeVisitor<R,
内のP> visitOther
- 実装要件:
- この実装では
null
が返されます。 - パラメータ:
node
- ビジットされているノードp
- パラメータ値- 戻り値:
- スキャン結果
-