java.lang.Object
com.sun.source.util.Trees
com.sun.source.util.DocTrees
public abstract class DocTrees extends Trees
ドキュメンテーション・コメントの構文ツリーへのアクセスを提供します。
- 導入されたバージョン:
- 1.8
-
コンストラクタのサマリー
-
メソッドのサマリー
修飾子と型メソッド説明abstract BreakIterator
ドキュメント・コメントの最初の文をコンピュートするために使用されるブレーク・イテレータを返します。abstract String
getCharacters
(EntityTree tree) 指定されたエンティティ・ツリー内のエンティティの文字を含む文字列を返します。ツリーが有効な一連の文字を表していない場合はnull
を返します。abstract DocCommentTree
getDocCommentTree
(TreePath path) 指定されたTreePathによって識別されるTreeノードのdocコメント・ツリーがあれば、それを返します。abstract DocCommentTree
指定された要素のドキュメント・コメント・ツリーを返します。abstract DocCommentTree
getDocCommentTree
(Element e, String relativePath) 指定された要素に相対してパスが指定された、指定されたファイルのドキュメント・コメント・ツリーを返します。abstract DocCommentTree
getDocCommentTree
(FileObject fileObject) 指定されたファイルのドキュメント・コメント・ツリーを返します。abstract DocTreeFactory
DocTree
オブジェクトを作成するためのユーティリティ・オブジェクトを返します。abstract DocTreePath
getDocTreePath
(FileObject fileObject, PackageElement packageElement) 指定されたファイルのドキュメント・コメント・ツリーを含むdocツリー・パスを返します。abstract Element
getElement
(DocTreePath path) 指定されたDocTreePath
のリーフ・ノードによって参照される言語モデル要素、または未知の場合はnull
を返します。getFirstSentence
(List<? extends DocTree> list) コメントの最初の文を表すDocTree
のリストを返します。abstract DocSourcePositions
ドキュメント・ツリー・ノードのソース位置にアクセスするためのユーティリティ・オブジェクトを返します。abstract TypeMirror
getType
(DocTreePath path) 指定されたDocTreePath
のリーフ・ノードによって参照される言語モデル・タイプを返します。不明な場合はnull
を返します。static DocTrees
指定されたProcessingEnvironmentのDocTreesオブジェクトを返します。static DocTrees
指定されたCompilationTaskのDocTreesオブジェクトを返します。abstract void
printMessage
(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) 指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力しますabstract void
setBreakIterator
(BreakIterator breakIterator) ドキュメントのコメントの最初の文をコンピュートするブレーク・イテレータを設定します。クラス com.sun.source.util.Treesで宣言されたメソッド
getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage
-
コンストラクタの詳細
-
DocTrees
public DocTrees()サブクラスが呼び出すためのコンストラクタ。
-
-
メソッドの詳細
-
instance
public static DocTrees instance(JavaCompiler.CompilationTask task) 指定されたCompilationTaskのDocTreesオブジェクトを返します。- パラメータ:
task
- Treesオブジェクトを取得するコンパイル・タスク- 戻り値:
- DocTreesオブジェクト
- 例外:
IllegalArgumentException
- タスクがTrees APIをサポートしていない場合。
-
instance
public static DocTrees instance(ProcessingEnvironment env) 指定されたProcessingEnvironmentのDocTreesオブジェクトを返します。- パラメータ:
env
- Treesオブジェクトを取得する処理環境- 戻り値:
- DocTreesオブジェクト
- 例外:
IllegalArgumentException
- envがTrees APIをサポートしていない場合。
-
getBreakIterator
public abstract BreakIterator getBreakIterator()ドキュメント・コメントの最初の文をコンピュートするために使用されるブレーク・イテレータを返します。 何も指定されていなければ、null
を返します。- 戻り値:
- ブレーク・イテレータ
- 導入されたバージョン:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(TreePath path) 指定されたTreePathによって識別されるTreeノードのdocコメント・ツリーがあれば、それを返します。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。- 実装上のノート:
- このメソッドのデフォルト実装は、同じ引数を持つ繰返し呼出しに対して同じ
DocCommentTree
インスタンスを返します。 - パラメータ:
path
- ツリー・ノードのパス- 戻り値:
- docコメント・ツリー
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e) 指定された要素のドキュメント・コメント・ツリーを返します。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。- 実装上のノート:
- このメソッドのデフォルト実装は、同じ引数を持つ繰返し呼出しに対して同じ
DocCommentTree
インスタンスを返します。 - パラメータ:
e
- ドキュメントが必要な要素- 戻り値:
- docコメント・ツリー
- 導入されたバージョン:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(FileObject fileObject) 指定されたファイルのドキュメント・コメント・ツリーを返します。 ファイルはHTMLファイルでなければなりません。その場合、ドキュメント・コメント・ツリーはファイルの内容全体を表します。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。 今後のリリースでは、追加のファイル型をサポートする可能性があります。- 実装上のノート:
- このメソッドのデフォルト実装は、起動ごとに新しい
DocCommentTree
インスタンスを返します。 - パラメータ:
fileObject
- コンテンツ・コンテナ- 戻り値:
- docコメント・ツリー
- 導入されたバージョン:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException 指定された要素に相対してパスが指定された、指定されたファイルのドキュメント・コメント・ツリーを返します。 ファイルはHTMLファイルでなければなりません。この場合、ドキュメント・コメント・ツリーは<body>タグの内容を表し、囲みタグは無視されます。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。 今後のリリースでは、追加のファイル型をサポートする可能性があります。- 実装上のノート:
- このメソッドのデフォルト実装は、起動ごとに新しい
DocCommentTree
インスタンスを返します。 - パラメータ:
e
- パスが参照として使用される要素relativePath
- 要素からの相対パス- 戻り値:
- docコメント・ツリー
- 例外:
IOException
- 例外が発生した場合- 導入されたバージョン:
- 9
-
getDocTreePath
public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement) 指定されたファイルのドキュメント・コメント・ツリーを含むdocツリー・パスを返します。 ファイルはHTMLファイルでなければなりません。この場合、ドキュメント・コメント・ツリーは<body>
タグの内容を表し、囲みタグは無視されます。 docコメント・ツリーの@see
タグと{@link}
タグに含まれるソース・コード要素への参照は、指定されたパッケージ要素のコンテキストで評価されます。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。- パラメータ:
fileObject
- HTMLコンテンツをカプセル化するファイル・オブジェクトpackageElement
- package.htmlを表す指定されたファイル・オブジェクトに関連付けるpackage要素、そうでない場合はnull- 戻り値:
- 指定されたファイルから解析されたdocコメントを含むdocツリー・パス
- 例外:
IllegalArgumentException
- fileObjectがHTMLファイルでない場合- 導入されたバージョン:
- 9
-
getElement
public abstract Element getElement(DocTreePath path) 指定されたDocTreePath
のリーフ・ノードによって参照される言語モデル要素、または未知の場合はnull
を返します。- パラメータ:
path
- ツリー・ノードのパス- 戻り値:
- 要素
-
getType
public abstract TypeMirror getType(DocTreePath path) 指定されたDocTreePath
のリーフ・ノードによって参照される言語モデル・タイプを返します。不明な場合はnull
を返します。 このメソッドは通常、getElement(DocTreePath)
がnull以外の値を返すpath
引数に対してgetElement(path).asType()
と同じ値を返しますが、RAW型のかわりにパラメータ化された汎用型などの追加情報を含む型を返すことがあります。- パラメータ:
path
- ツリー・ノードのパス- 戻り値:
- 参照される型、またはnull
- 導入されたバージョン:
- 15
-
getFirstSentence
コメントの最初の文を表すDocTree
のリストを返します。- パラメータ:
list
- 質問するDocTreeリスト- 戻り値:
- 最初の文
- 導入されたバージョン:
- 9
-
getSourcePositions
public abstract DocSourcePositions getSourcePositions()ドキュメント・ツリー・ノードのソース位置にアクセスするためのユーティリティ・オブジェクトを返します。- 定義:
getSourcePositions
、クラスTrees
- 戻り値:
- ユーティリティ・オブジェクト
-
printMessage
public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) 指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します- パラメータ:
kind
- メッセージの種類msg
- メッセージ、ない場合は空の文字列t
- 位置のヒントとして使用するツリーc
- 位置ヒントとして使用するドキュメント・コメント・ツリーroot
- ツリーを格納するコンパイル・ユニット
-
setBreakIterator
public abstract void setBreakIterator(BreakIterator breakIterator) ドキュメントのコメントの最初の文をコンピュートするブレーク・イテレータを設定します。- パラメータ:
breakIterator
- ブレーク・イテレータまたはnull
を使用して、デフォルトの文ブレーカを指定- 導入されたバージョン:
- 9
-
getDocTreeFactory
public abstract DocTreeFactory getDocTreeFactory()DocTree
オブジェクトを作成するためのユーティリティ・オブジェクトを返します。- 戻り値:
DocTree
オブジェクトを作成するユーティリティ・オブジェクト- 導入されたバージョン:
- 9
-
getCharacters
public abstract String getCharacters(EntityTree tree) 指定されたエンティティ・ツリー内のエンティティの文字を含む文字列を返します。ツリーが有効な一連の文字を表していない場合はnull
を返します。エンティティの解釈は、HTML 5.2仕様のセクション「8.1.4.文字参照」に基づきます。
- パラメータ:
tree
- エンティティを含むツリー- 戻り値:
- 文字を含む文字列
-