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

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`	`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`	`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()`	著者名を返します。
`List<? extends DocTree>`	SeeTree.`getReference()`	参照を返します。
`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`のリストを返します。
`Iterator<DocTree>`	DocTreePath.`iterator()`

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)`	新しい`IndexTree`オブジェクトを作成し、`{@index }` タグを表します。
`abstract void`	DocTrees.`printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)`	指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します
`R`	DocTreePathScanner.`scan(DocTree tree, P p)`	1つのノードをスキャンします。
`R`	DocTreeScanner.`scan(DocTree node, P p)`	1つのノードをスキャンします。
`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)`	新しい`AttributeTree`オブジェクトを作成し、HTMLタグのHTML属性を表します。
`AuthorTree`	DocTreeFactory.`newAuthorTree(List<? extends DocTree> name)`	新しい`AuthorTree`オブジェクトを作成し、`{@author }` タグを表します。
`DeprecatedTree`	DocTreeFactory.`newDeprecatedTree(List<? extends DocTree> text)`	新しい`DeprecatedTree`オブジェクトを作成し、`{@deprecated }` タグを表します。
`DocCommentTree`	DocTreeFactory.`newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)`	完全なドキュメント・コメントを表すために、新しい`DocCommentTree`オブジェクトを作成します。
`ThrowsTree`	DocTreeFactory.`newExceptionTree(ReferenceTree name, List<? extends DocTree> description)`	新しい`ExceptionTree`オブジェクトを作成し、`@exception` タグを表します。
`HiddenTree`	DocTreeFactory.`newHiddenTree(List<? extends DocTree> text)`	新しい`HiddenTree`オブジェクトを作成し、`{@hidden }` タグを表します。
`IndexTree`	DocTreeFactory.`newIndexTree(DocTree term, List<? extends DocTree> description)`	新しい`IndexTree`オブジェクトを作成し、`{@index }` タグを表します。
`LinkTree`	DocTreeFactory.`newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)`	新しい`LinkPlainTree`オブジェクトを作成し、`{@linkplain }` タグを表します。
`LinkTree`	DocTreeFactory.`newLinkTree(ReferenceTree ref, List<? extends DocTree> label)`	新しい`LinkTree`オブジェクトを作成し、`{@link }` タグを表します。
`ParamTree`	DocTreeFactory.`newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)`	新しい`ParamTree`オブジェクトを作成し、`@param` タグを表します。
`ProvidesTree`	DocTreeFactory.`newProvidesTree(ReferenceTree name, List<? extends DocTree> description)`	新しい`ProvidesTree`オブジェクトを作成し、`@provides` タグを表します。
`ReturnTree`	DocTreeFactory.`newReturnTree(List<? extends DocTree> description)`	新しい`ReturnTree`オブジェクトを作成し、`@return` タグを表します。
`SeeTree`	DocTreeFactory.`newSeeTree(List<? extends DocTree> reference)`	新しい`SeeTree`オブジェクトを作成し、`@see` タグを表します。
`SerialDataTree`	DocTreeFactory.`newSerialDataTree(List<? extends DocTree> description)`	新しい`SerialDataTree`オブジェクトを作成し、`@serialData` タグを表します。
`SerialFieldTree`	DocTreeFactory.`newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)`	新しい`SerialFieldTree`オブジェクトを作成し、`@serialField` タグを表します。
`SerialTree`	DocTreeFactory.`newSerialTree(List<? extends DocTree> description)`	新しい`SerialTree`オブジェクトを作成し、`@serial` タグを表します。
`SinceTree`	DocTreeFactory.`newSinceTree(List<? extends DocTree> text)`	新しい`SinceTree`オブジェクトを作成し、`@since` タグを表します。
`StartElementTree`	DocTreeFactory.`newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)`	新しい`StartElementTree`オブジェクトを作成して、HTML要素の開始点を表します。
`ThrowsTree`	DocTreeFactory.`newThrowsTree(ReferenceTree name, List<? extends DocTree> description)`	新しい`ThrowsTree`オブジェクトを作成し、`@throws` タグを表します。
`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)`	新しい`UsesTree`オブジェクトを作成し、`@uses` タグを表します。
`VersionTree`	DocTreeFactory.`newVersionTree(List<? extends DocTree> text)`	新しい`VersionTree`オブジェクトを作成し、`{@version }` タグを表します。
`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)`	生成された出力に含まれる、このタグの一連のインスタンスの文字列表現を返します。