インタフェースcom.sun.source.doctree.DocTreeの使用 (Java SE 11 & JDK 11)

DocTreeを使用しているパッケージ
パッケージ	説明
com.sun.source.doctree	ドキュメンテーション・コメントを抽象構文ツリー(AST)として表すためのインタフェースを提供します。
com.sun.source.util	抽象構文ツリー(Abstract Syntax Tree、AST)の操作のためのユーティリティを提供します。
jdk.javadoc.doclet	ドックレットAPIは、言語モデルAPIおよびコンパイラ・ツリーAPIとともに、クライアントがプログラムおよびライブラリのソース・レベルの構造(ソースに埋め込まれたAPIコメントを含む)を検査できる環境を提供します。

com.sun.source.doctreeでのDocTreeの使用

com.sun.source.doctreeでのDocTreeのサブインタフェース
修飾子と型	インタフェース	説明
`interface`	`AttributeTree`	HTML要素の属性のツリー・ノードです。
`interface`	`AuthorTree`	@authorブロック・タグのツリー・ノードです。
`interface`	`BlockTagTree`	異なる型のブロック・タグの基底クラスとして使用されるツリー・ノードです。
`interface`	`CommentTree`	埋込みHTMLコメントです。
`interface`	`DeprecatedTree`	@deprecatedブロック・タグのツリー・ノードです。
`interface`	`DocCommentTree`	ドキュメンテーション・コメントの最上位レベル表現です。
`interface`	`DocRootTree`	@docrootインライン・タグのツリー・ノードです。
`interface`	`DocTypeTree`	`doctype`宣言のツリー・ノード。
`interface`	`EndElementTree`	HTML要素の終了のツリー・ノードです。
`interface`	`EntityTree`	HTMLエンティティのツリー・ノードです。
`interface`	`ErroneousTree`	不正なテキストの代用となるツリー・ノードです。
`interface`	`HiddenTree`	@hiddenブロック・タグのツリー・ノード。
`interface`	`IdentifierTree`	ドキュメンテーション・コメントの識別子です。
`interface`	`IndexTree`	@indexまたは@indexインライン・タグのツリー・ノード。
`interface`	`InheritDocTree`	@inheritDocインライン・タグのツリー・ノードです。
`interface`	`InlineTagTree`	異なる型のインライン・タグの基底クラスとして使用されるツリー・ノードです。
`interface`	`LinkTree`	@linkまたは@linkplainインライン・タグのツリー・ノードです。
`interface`	`LiteralTree`	@literalまたは@codeインライン・タグのツリー・ノードです。
`interface`	`ParamTree`	@paramブロック・タグのツリー・ノードです。
`interface`	`ProvidesTree`	@providesブロック・タグのツリー・ノード。
`interface`	`ReferenceTree`	Java言語要素への参照用のツリー・ノード。
`interface`	`ReturnTree`	@returnブロック・タグのツリー・ノードです。
`interface`	`SeeTree`	@seeブロック・タグのツリー・ノードです。
`interface`	`SerialDataTree`	@serialDataブロック・タグのツリー・ノードです。
`interface`	`SerialFieldTree`	@serialDataブロック・タグのツリー・ノードです。
`interface`	`SerialTree`	@serialブロック・タグのツリー・ノードです。
`interface`	`SinceTree`	@sinceブロック・タグのツリー・ノードです。
`interface`	`StartElementTree`	HTML要素の開始のツリー・ノードです。
`interface`	`SummaryTree`	@summaryインライン・タグのツリー・ノード。
`interface`	`TextTree`	プレーン・テキストのツリー・ノードです。
`interface`	`ThrowsTree`	@exceptionまたは@throwsブロック・タグのツリー・ノードです。
`interface`	`UnknownBlockTagTree`	認識されないインライン・タグのツリー・ノードです。
`interface`	`UnknownInlineTagTree`	認識されないインライン・タグのツリー・ノードです。
`interface`	`UsesTree`	@usesブロック・タグのツリー・ノード。
`interface`	`ValueTree`	@valueインライン・タグのツリー・ノードです。
`interface`	`VersionTree`	@versionブロック・タグのツリー・ノードです。

DocTreeを返すcom.sun.source.doctreeのメソッド
修飾子と型	メソッド	説明
`DocTree`	IndexTree.`getSearchTerm()`	指定された検索語を返します。

DocTree型の引数を持つ型を返すcom.sun.source.doctreeのメソッド
修飾子と型	メソッド	説明
`List<? extends DocTree>`	StartElementTree.`getAttributes()`	この要素によって定義された属性を返します。
`List<? extends DocTree>`	DocCommentTree.`getBlockTags()`	ドキュメント・コメントのブロック・タグを返します。
`List<? extends DocTree>`	DeprecatedTree.`getBody()`	アイテムが非推奨になった理由を説明する説明を返します。
`List<? extends DocTree>`	DocCommentTree.`getBody()`	ドキュメント・コメントの本文を返します。最初の文の後およびブロック・タグの前に表示されます。
`List<? extends DocTree>`	HiddenTree.`getBody()`	アイテムが非表示になっている理由を説明する説明を返します。
`List<? extends DocTree>`	SinceTree.`getBody()`	ドキュメント化されているアイテムの利用可能状況を説明するテキストを返します。
`List<? extends DocTree>`	VersionTree.`getBody()`	タグの本体を返します。
`List<? extends DocTree>`	UnknownBlockTagTree.`getContent()`	認識されないブロック・タグの内容を返します。
`List<? extends DocTree>`	UnknownInlineTagTree.`getContent()`	認識されないインライン・タグの内容を返します。
`List<? extends DocTree>`	IndexTree.`getDescription()`	説明(ある場合)を返します。
`List<? extends DocTree>`	ParamTree.`getDescription()`	パラメータの説明を返します。
`List<? extends DocTree>`	ProvidesTree.`getDescription()`	モジュールによって提供されているサービス・タイプの説明を返します。
`List<? extends DocTree>`	ReturnTree.`getDescription()`	メソッドの戻り値の説明を返します。
`List<? extends DocTree>`	SerialDataTree.`getDescription()`	シリアル・データの説明を返します。
`List<? extends DocTree>`	SerialFieldTree.`getDescription()`	シリアル・フィールドの説明を返します。
`List<? extends DocTree>`	SerialTree.`getDescription()`	フィールドの説明、または"include"または"exclude"という語を返します。
`List<? extends DocTree>`	ThrowsTree.`getDescription()`	例外がスローされる理由の説明を返します。
`List<? extends DocTree>`	UsesTree.`getDescription()`	モジュール内のサービス・タイプの使用の説明を返します。
`List<? extends DocTree>`	DocCommentTree.`getFirstSentence()`	ドキュメント・コメントの最初の文を返します。
`default List<? extends DocTree>`	DocCommentTree.`getFullBody()`	ドキュメント・コメントの本文全体を返します。最初の文を含むブロック・タグの前に表示されます。
`List<? extends DocTree>`	LinkTree.`getLabel()`	リンクのラベル(存在する場合)を返します。
`List<? extends DocTree>`	AuthorTree.`getName()`	作成者の名前を返します。
`default List<? extends DocTree>`	DocCommentTree.`getPostamble()`	ドキュメント・コメントのコンテンツに続くコンテンツ(ある場合)を含むツリーのリストを返します。
`default List<? extends DocTree>`	DocCommentTree.`getPreamble()`	ドキュメント・コメントのコンテンツの前のコンテンツ(ある場合)を含むツリーのリストを返します。
`List<? extends DocTree>`	SeeTree.`getReference()`	参照を返します。
`List<? extends DocTree>`	SummaryTree.`getSummary()`	サマリーまたはコメントの最初の行を返します。
`List<? extends DocTree>`	AttributeTree.`getValue()`	属性の値を返します。種類がEMPTYの場合は`null`を返します。

DocTree型のパラメータを持つcom.sun.source.doctreeのメソッド
修飾子と型	メソッド	説明
`R`	DocTreeVisitor.`visitOther(DocTree node, P p)`	不明なタイプのDocTreeノードにアクセスします。

com.sun.source.utilでのDocTreeの使用

DocTreeを返すcom.sun.source.utilのメソッド
修飾子と型	メソッド	説明
`DocTree`	DocTreePath.`getLeaf()`	このパスのリーフ・ノードを返します。

DocTree型の引数を持つ型を返すcom.sun.source.utilのメソッド
修飾子と型	メソッド	説明
`List<DocTree>`	DocTreeFactory.`getFirstSentence(List<? extends DocTree> list)`	コンテンツのリストに含まれる最初の文を取得します。
`abstract List<DocTree>`	DocTrees.`getFirstSentence(List<? extends DocTree> list)`	コメントの最初の文を表す`DocTree`のリストを返します。

DocTree型のパラメータを持つcom.sun.source.utilのメソッド
修飾子と型	メソッド	説明
`protected R`	SimpleDocTreeVisitor.`defaultAction(DocTree node, P p)`	上書きされないすべてのビジット方法で使用されるデフォルト処理です。
`long`	DocSourcePositions.`getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	ファイル内のコメント内のツリーの終了位置を返します。
`static DocTreePath`	DocTreePath.`getPath(DocTreePath path, DocTree target)`	DocTreePathオブジェクトで識別されるサブツリー内のツリー・ノードのドキュメント・ツリー・パスを返します。ノードが見つからない場合は`null`を返します。
`static DocTreePath`	DocTreePath.`getPath(TreePath treePath, DocCommentTree doc, DocTree target)`	コンパイル・ユニット内のツリー・ノードのドキュメント・ツリー・パスを返します。ノードが見つからない場合は`null`を返します。
`long`	DocSourcePositions.`getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)`	ファイル内のコメント内のツリーの開始位置を返します。
`IndexTree`	DocTreeFactory.`newIndexTree(DocTree term, List<? extends DocTree> description)`	`{@index }` タグを表す新しい`IndexTree`オブジェクトを作成します。
`abstract void`	DocTrees.`printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)`	指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します
`R`	DocTreePathScanner.`scan(DocTree tree, P p)`	単一ノードをスキャンします。
`R`	DocTreeScanner.`scan(DocTree node, P p)`	単一ノードをスキャンします。
`R`	SimpleDocTreeVisitor.`visit(DocTree node, P p)`	ノードのタイプに固有の適切な訪問メソッドを呼び出します。
`R`	DocTreeScanner.`visitOther(DocTree node, P p)`	不明なタイプのDocTreeノードにアクセスします。
`R`	SimpleDocTreeVisitor.`visitOther(DocTree node, P p)`	不明なタイプのDocTreeノードにアクセスします。

DocTree型の型引数を持つcom.sun.source.utilのメソッド・パラメータ
修飾子と型	メソッド	説明
`List<DocTree>`	DocTreeFactory.`getFirstSentence(List<? extends DocTree> list)`	コンテンツのリストに含まれる最初の文を取得します。
`abstract List<DocTree>`	DocTrees.`getFirstSentence(List<? extends DocTree> list)`	コメントの最初の文を表す`DocTree`のリストを返します。
`AttributeTree`	DocTreeFactory.`newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)`	HTMLタグのHTML属性を表す新しい`AttributeTree`オブジェクトを作成します。
`AuthorTree`	DocTreeFactory.`newAuthorTree(List<? extends DocTree> name)`	`{@author }` タグを表す新しい`AuthorTree`オブジェクトを作成します。
`DeprecatedTree`	DocTreeFactory.`newDeprecatedTree(List<? extends DocTree> text)`	`{@deprecated }` タグを表す新しい`DeprecatedTree`オブジェクトを作成します。
`DocCommentTree`	DocTreeFactory.`newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)`	完全なドキュメント・コメントを表す新しい`DocCommentTree`オブジェクトを作成します。
`DocCommentTree`	DocTreeFactory.`newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)`	enitireドキュメント・コメントを表す新しい`DocCommentTree`オブジェクトを作成します。
`ThrowsTree`	DocTreeFactory.`newExceptionTree(ReferenceTree name, List<? extends DocTree> description)`	`@exception` タグを表す新しい`ExceptionTree`オブジェクトを作成します。
`HiddenTree`	DocTreeFactory.`newHiddenTree(List<? extends DocTree> text)`	`{@hidden }` タグを表す新しい`HiddenTree`オブジェクトを作成します。
`IndexTree`	DocTreeFactory.`newIndexTree(DocTree term, List<? extends DocTree> description)`	`{@index }` タグを表す新しい`IndexTree`オブジェクトを作成します。
`LinkTree`	DocTreeFactory.`newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)`	`{@linkplain }` タグを表す新しい`LinkPlainTree`オブジェクトを作成します。
`LinkTree`	DocTreeFactory.`newLinkTree(ReferenceTree ref, List<? extends DocTree> label)`	`{@link }` タグを表す新しい`LinkTree`オブジェクトを作成します。
`ParamTree`	DocTreeFactory.`newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)`	`@param` タグを表す新しい`ParamTree`オブジェクトを作成します。
`ProvidesTree`	DocTreeFactory.`newProvidesTree(ReferenceTree name, List<? extends DocTree> description)`	`@provides` タグを表す新しい`ProvidesTree`オブジェクトを作成します。
`ReturnTree`	DocTreeFactory.`newReturnTree(List<? extends DocTree> description)`	`@return` タグを表す新しい`ReturnTree`オブジェクトを作成します。
`SeeTree`	DocTreeFactory.`newSeeTree(List<? extends DocTree> reference)`	`@see` タグを表す新しい`SeeTree`オブジェクトを作成します。
`SerialDataTree`	DocTreeFactory.`newSerialDataTree(List<? extends DocTree> description)`	`@serialData` タグを表す新しい`SerialDataTree`オブジェクトを作成します。
`SerialFieldTree`	DocTreeFactory.`newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)`	`@serialField` タグを表す新しい`SerialFieldTree`オブジェクトを作成します。
`SerialTree`	DocTreeFactory.`newSerialTree(List<? extends DocTree> description)`	`@serial` タグを表す新しい`SerialTree`オブジェクトを作成します。
`SinceTree`	DocTreeFactory.`newSinceTree(List<? extends DocTree> text)`	`@since` タグを表す新しい`SinceTree`オブジェクトを作成します。
`StartElementTree`	DocTreeFactory.`newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)`	HTML要素の開始を表す新しい`StartElementTree`オブジェクトを作成します。
`default SummaryTree`	DocTreeFactory.`newSummaryTree(List<? extends DocTree> summary)`	`@summary` タグを表す新しい`SummaryTree`オブジェクトを作成します。
`ThrowsTree`	DocTreeFactory.`newThrowsTree(ReferenceTree name, List<? extends DocTree> description)`	`@throws` タグを表す新しい`ThrowsTree`オブジェクトを作成します。
`UnknownBlockTagTree`	DocTreeFactory.`newUnknownBlockTagTree(Name name, List<? extends DocTree> content)`	認識されないブロック・タグを表す新しい`UnknownBlockTagTree`オブジェクトを作成します。
`UnknownInlineTagTree`	DocTreeFactory.`newUnknownInlineTagTree(Name name, List<? extends DocTree> content)`	認識されないインライン・タグを表す新しい`UnknownInlineTagTree`オブジェクトを作成します。
`UsesTree`	DocTreeFactory.`newUsesTree(ReferenceTree name, List<? extends DocTree> description)`	`@uses` タグを表す新しい`UsesTree`オブジェクトを作成します。
`VersionTree`	DocTreeFactory.`newVersionTree(List<? extends DocTree> text)`	`{@version }` タグを表す新しい`VersionTree`オブジェクトを作成します。
`R`	DocTreeScanner.`scan(Iterable<? extends DocTree> nodes, P p)`	一連のノードをスキャンします。
`R`	SimpleDocTreeVisitor.`visit(Iterable<? extends DocTree> nodes, P p)`	各ノード・シーケンスで適切な訪問メソッドを呼び出します。

DocTree型のパラメータを持つcom.sun.source.utilのコンストラクタ
コンストラクタ	説明
`DocTreePath(DocTreePath p, DocTree t)`	子ノードのDocTreePathを作成します。

jdk.javadoc.docletでのDocTreeの使用

DocTree型の型引数を持つjdk.javadoc.docletのメソッド・パラメータ
修飾子と型	メソッド	説明
`String`	Taglet.`toString(List<? extends DocTree> tags, Element element)`	生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。