com.sun.source.util

クラスDocTrees

java.lang.Object

com.sun.source.util.Trees

com.sun.source.util.DocTrees

@Exported
public abstract class DocTrees
extends Trees

ドキュメンテーション・コメントの構文ツリーへのアクセスを提供します。

導入されたバージョン:

1.8

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

コンストラクタ

コンストラクタと説明
DocTrees()

メソッドのサマリー

修飾子と型	メソッドと説明
abstract DocCommentTree	getDocCommentTree(TreePath path) 指定されたTreePathによって識別されるTreeノードのドキュメンテーション・コメント・ツリー(存在する場合)を取得します。
abstract Element	getElement(DocTreePath path) 指定されたDocTreePathのリーフ・ノードによって参照される言語モデル要素を取得し、不明な場合はnullを取得します。
abstract DocSourcePositions	getSourcePositions() ソース位置を取得するためのユーティリティ・オブジェクトを取得します。
static DocTrees	instance(JavaCompiler.CompilationTask task) 指定されたCompilationTaskのDocTreesオブジェクトを取得します。
static DocTrees	instance(ProcessingEnvironment env) 指定されたProcessingEnvironmentのDocTreesオブジェクトを取得します。
abstract void	printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) 指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します

クラス com.sun.source.util.Treesから継承されたメソッド

getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage

クラス java.lang.Objectから継承されたメソッド

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

コンストラクタの詳細

DocTrees

public DocTrees()

メソッドの詳細

instance

public static DocTrees instance(JavaCompiler.CompilationTask task)

指定されたCompilationTaskのDocTreesオブジェクトを取得します。

パラメータ:

task - Treesオブジェクトを取得するコンパイル・タスク

例外:

IllegalArgumentException - タスクがTrees APIをサポートしていない場合。

instance

public static DocTrees instance(ProcessingEnvironment env)

指定されたProcessingEnvironmentのDocTreesオブジェクトを取得します。

パラメータ:

env - Treesオブジェクトを取得する処理環境

例外:

IllegalArgumentException - envがTrees APIをサポートしていない場合。

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(TreePath path)

指定されたTreePathによって識別されるTreeノードのドキュメンテーション・コメント・ツリー(存在する場合)を取得します。ドキュメンテーション・コメントが見つからなかった場合はnullを返します。

getElement

public abstract Element getElement(DocTreePath path)

指定されたDocTreePathのリーフ・ノードによって参照される言語モデル要素を取得し、不明な場合はnullを取得します。

getSourcePositions

public abstract DocSourcePositions getSourcePositions()

次のクラスからコピーされた説明: Trees

ソース位置を取得するためのユーティリティ・オブジェクトを取得します。

定義:

getSourcePositions、クラス: Trees

printMessage

public abstract void printMessage(Diagnostic.Kind kind,
                                  CharSequence msg,
                                  DocTree t,
                                  DocCommentTree c,
                                  CompilationUnitTree root)

指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します

パラメータ:

kind - メッセージの種類

msg - メッセージ、ない場合は空の文字列

t - 位置のヒントとして使用するツリー

root - ツリーを格納するコンパイル・ユニット