インタフェース
com.sun.source.doctree.DocTreeの使用

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	EscapeTree	エスケープ・シーケンスで表される文字のツリー・ノード。
interface	HiddenTree	@hiddenブロック・タグのツリー・ノードです。
interface	IdentifierTree	ドキュメンテーション・コメントの識別子です。
interface	IndexTree	@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	@serialFieldブロック・タグのツリー・ノードです。
interface	SerialTree	@serialブロック・タグのツリー・ノードです。
interface	SinceTree	@sinceブロック・タグのツリー・ノードです。
interface	SnippetTree	@snippetのインライン・タグのツリー・ノード。
interface	SpecTree	@specブロック・タグのツリー・ノードです。
interface	StartElementTree	HTML要素の開始のツリー・ノードです。
interface	SummaryTree	@summaryのインライン・タグのツリー・ノード。
interface	SystemPropertyTree	@systemPropertyのインライン・タグのツリー・ノード。
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>	SnippetTree.getAttributes()	@snippetタグの属性のリストを返します。
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>	SpecTree.getTitle()	タイトルを返します。
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)	{@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)	単一ノードをスキャンします。
final 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要素またはタグの属性を表す新しい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)	ドキュメンテーション・コメント全体を表す新しいDocCommentTreeオブジェクトを作成します。
ThrowsTree	DocTreeFactory.newExceptionTree(ReferenceTree name, List<? extends DocTree> description)	@exceptionタグを表す新しいThrowsTreeオブジェクトを作成します。
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 }タグを表す新しいLinkTreeオブジェクトを作成します。
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オブジェクトを作成します。
default ReturnTree	DocTreeFactory.newReturnTree(boolean isInline, List<? extends DocTree> description)	@returnタグまたは{@return}タグを表す新しいReturnTreeオブジェクトを作成します。
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オブジェクトを作成します。
SnippetTree	DocTreeFactory.newSnippetTree(List<? extends DocTree> attributes, TextTree text)	{@snippet }タグを表す新しいSnippetTreeオブジェクトを作成します。
SpecTree	DocTreeFactory.newSpecTree(TextTree url, List<? extends DocTree> title)	@specタグを表す新しいSpecTreeオブジェクトを作成します。
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)	一連のノードをスキャンします。
final 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)	生成された出力に含める、このタグの一連のインスタンスの文字列表現を返します。