クラスDocTreePathScanner<R,P>

java.lang.Object

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

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

型パラメータ:

R - このビジターのメソッドの戻り型。 結果を返すことを必要としないビジターのVoidを使用する。

P - このビジターのメソッドに対する追加パラメータのタイプ。 追加のパラメータを必要としないビジターのVoidを使用する。

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

DocTreeVisitor<R,P>

public class DocTreePathScanner<R,P> extends DocTreeScanner<R,P>

すべての子ツリー・ノードを巡回し、親ノードのパスを維持するためのサポートを提供するDocTreeVisitorです。 特定の型のノードを巡回するには、対応するvisitorXYZメソッドを単にオーバーライドします。 独自のメソッド内では、super.visitXYZを呼び出して、下位ノードを巡回します。

導入されたバージョン:

1.8

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

コンストラクタ

コンストラクタ	説明
DocTreePathScanner()	DocTreePathScannerを構築します。

メソッドのサマリー

修飾子と型	メソッド	説明
DocTreePath	getCurrentPath()	現在アクティブなスキャン・コールのセットによって構築された、ノードの現在のパスを返します。
R	scan(DocTree tree, P p)	単一ノードをスキャンします。
R	scan(DocTreePath path, P p)	ツリー・パスで識別される位置からツリーをスキャンします。

クラスで宣言されたメソッド DocTreeScanner

reduce, scan, visitAttribute, visitAuthor, visitComment, visitDeprecated, visitDocComment, visitDocRoot, visitDocType, visitEndElement, visitEntity, visitErroneous, visitEscape, visitHidden, visitIdentifier, visitIndex, visitInheritDoc, visitLink, visitLiteral, visitOther, visitParam, visitProvides, visitRawText, visitReference, visitReturn, visitSee, visitSerial, visitSerialData, visitSerialField, visitSince, visitSnippet, visitSpec, visitStartElement, visitSummary, visitSystemProperty, visitText, visitThrows, visitUnknownBlockTag, visitUnknownInlineTag, visitUses, visitValue, visitVersion

修飾子と型	メソッド	説明
R	reduce(R r1, R r2)	2つの結果を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	visitEscape(EscapeTree node, P p)	EscapeTreeノードにアクセスします。
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	visitRawText(RawTextTree node, P p)	RawTextTreeノードにアクセスします。
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	visitSpec(SpecTree node, P p)	SpecTreeノードにアクセスします。
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ノードにビジットします。

クラスオブジェクトで宣言されたメソッド

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

修飾子と型	メソッド	説明
protected Object	clone()	このオブジェクトのコピーを作成して、返します。
boolean	equals(Object obj)	このオブジェクトと他のオブジェクトが等しいかどうかを示します。
protected void	finalize()	削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。 最終決定は非推奨であり、将来のリリースで削除される可能性があります。
final Class<?>	getClass()	このObjectの実行時クラスを返します。
int	hashCode()	このオブジェクトに対するハッシュ・コード値を返します。
final void	notify()	このオブジェクトのモニターで待機中のスレッドを1つ再開します。
final void	notifyAll()	このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
String	toString()	オブジェクトの文字列表現を返します。
final void	wait()	現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
final void	wait(long timeoutMillis)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
final void	wait(long timeoutMillis, int nanos)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

コンストラクタの詳細

DocTreePathScanner

public DocTreePathScanner()

DocTreePathScannerを構築します。

メソッドの詳細

scan

public R scan(DocTreePath path, P p)

ツリー・パスで識別される位置からツリーをスキャンします。

パラメータ:

path - パス

p - ビジター・メソッドに渡す値

戻り値:

メイン・ビジター・メソッドから返された結果

scan

public R scan(DocTree tree, P p)

単一ノードをスキャンします。 現在のパスは、スキャンの期間中に更新されます。

オーバーライド:

クラスDocTreeScanner<R,P>のscan

パラメータ:

tree - スキャンされるツリー

p - ビジター・メソッドに渡す値

戻り値:

メイン・ビジター・メソッドから返された結果

getCurrentPath

public DocTreePath getCurrentPath()

現在アクティブなスキャン・コールのセットによって構築された、ノードの現在のパスを返します。

戻り値:

現在のパス