- java.lang.Object
-
- com.sun.source.util.Trees
-
- com.sun.source.util.DocTrees
-
public abstract class DocTrees extends Trees
ドキュメンテーション・コメントの構文ツリーへのアクセスを提供します。- 導入されたバージョン:
- 1.8
-
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 DocTrees()
-
メソッドのサマリー
修飾子と型 メソッド 説明 abstract BreakIterator
getBreakIterator()
ドキュメント・コメントの最初の文をコンピュートするために使用されるブレーク・イテレータを返します。abstract DocCommentTree
getDocCommentTree(TreePath path)
指定されたTreePathによって識別されるTreeノードのdocコメント・ツリーがあれば、それを返します。abstract DocCommentTree
getDocCommentTree(Element e)
指定された要素のドキュメント・コメント・ツリーを返します。abstract DocCommentTree
getDocCommentTree(Element e, String relativePath)
指定された要素に相対してパスが指定された、指定されたファイルのドキュメント・コメント・ツリーを返します。abstract DocCommentTree
getDocCommentTree(FileObject fileObject)
指定されたファイルのドキュメント・コメント・ツリーを返します。abstract DocTreeFactory
getDocTreeFactory()
DocTree
オブジェクトを作成するためのユーティリティ・オブジェクトを返します。abstract DocTreePath
getDocTreePath(FileObject fileObject, PackageElement packageElement)
指定されたファイルのドキュメント・コメント・ツリーを含むdocツリー・パスを返します。abstract Element
getElement(DocTreePath path)
指定されたDocTreePath
のリーフ・ノードによって参照される言語モデル要素、または未知の場合はnull
を返します。abstract List<DocTree>
getFirstSentence(List<? extends DocTree> list)
コメントの最初の文を表すDocTree
のリストを返します。abstract DocSourcePositions
getSourcePositions()
ドキュメント・ツリー・ノードのソース位置にアクセスするためのユーティリティ・オブジェクトを返します。static DocTrees
instance(ProcessingEnvironment env)
指定されたProcessingEnvironmentのDocTreesオブジェクトを返します。static DocTrees
instance(JavaCompiler.CompilationTask task)
指定された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
-
-
-
-
メソッドの詳細
-
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
を返します。- パラメータ:
path
- ツリー・ノードのパス- 戻り値:
- docコメント・ツリー
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e)
指定された要素のドキュメント・コメント・ツリーを返します。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。- パラメータ:
e
- ドキュメントが必要な要素- 戻り値:
- docコメント・ツリー
- 導入されたバージョン:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(FileObject fileObject)
指定されたファイルのドキュメント・コメント・ツリーを返します。 ファイルはHTMLファイルでなければなりません。その場合、ドキュメント・コメント・ツリーはファイルの内容全体を表します。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。 今後のリリースでは、追加のファイル型をサポートする可能性があります。- パラメータ:
fileObject
- コンテンツ・コンテナ- 戻り値:
- docコメント・ツリー
- 導入されたバージョン:
- 9
-
getDocCommentTree
public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException
指定された要素に相対してパスが指定された、指定されたファイルのドキュメント・コメント・ツリーを返します。 ファイルはHTMLファイルでなければなりません。この場合、ドキュメント・コメント・ツリーは<body>タグの内容を表し、囲みタグは無視されます。 ドキュメンテーション・コメントが見つからない場合は、null
を返します。 今後のリリースでは、追加のファイル型をサポートする可能性があります。- パラメータ:
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
- ツリー・ノードのパス- 戻り値:
- 要素
-
getFirstSentence
public abstract List<DocTree> getFirstSentence(List<? extends DocTree> list)
コメントの最初の文を表す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
-
-