インタフェース
com.sun.source.doctree.DocTreeの使用
パッケージ
説明
ドキュメンテーション・コメントを抽象構文ツリー(AST)として表すためのインタフェースを提供します。
抽象構文ツリー(Abstract Syntax Tree、AST)の操作のためのユーティリティを提供します。
ドックレットAPIは、言語モデルAPIおよびコンパイラ・ツリーAPIとともに、クライアントがソースに埋め込まれたAPIコメントを含むプログラムおよびライブラリのソース・レベルの構造を検査できる環境を提供します。
-
com.sun.source.doctreeでのDocTreeの使用
修飾子と型インタフェース説明interface
HTML要素またはタグ内の属性のツリー・ノード。interface
@author
ブロック・タグのツリー・ノードです。interface
異なる型のブロック・タグの基底クラスとして使用されるツリー・ノードです。interface
埋込みHTMLコメントです。interface
@deprecated
ブロック・タグのツリー・ノードです。interface
ドキュメンテーション・コメントのトップレベル表現。interface
@docRoot
のインライン・タグのツリー・ノード。interface
doctype
宣言のツリー・ノード。interface
HTML要素の終了のツリー・ノードです。interface
HTMLエンティティのツリー・ノードです。interface
不正なテキストを表すツリー・ノード。interface
エスケープ・シーケンスで表される文字のツリー・ノード。interface
@hidden
ブロック・タグのツリー・ノードです。interface
ドキュメンテーション・コメントの識別子です。interface
@index
のインライン・タグのツリー・ノード。interface
@inheritDoc
のインライン・タグのツリー・ノード。interface
異なる型のインライン・タグの基底クラスとして使用されるツリー・ノードです。interface
@link
または@linkplain
インライン・タグのツリー・ノード。interface
@literal
または@code
インライン・タグのツリー・ノード。interface
@param
ブロック・タグのツリー・ノードです。interface
@provides
ブロック・タグのツリー・ノードです。interface
Java言語要素への参照用のツリー・ノード。interface
@return
ブロック・タグのツリー・ノードです。interface
@see
ブロック・タグのツリー・ノードです。interface
@serialData
ブロック・タグのツリー・ノードです。interface
@serialField
ブロック・タグのツリー・ノードです。interface
@serial
ブロック・タグのツリー・ノードです。interface
@since
ブロック・タグのツリー・ノードです。interface
@snippet
のインライン・タグのツリー・ノード。interface
@spec
ブロック・タグのツリー・ノードです。interface
HTML要素の開始のツリー・ノードです。interface
@summary
のインライン・タグのツリー・ノード。interface
@systemProperty
のインライン・タグのツリー・ノード。interface
プレーン・テキストのツリー・ノードです。interface
@exception
または@throws
ブロック・タグのツリー・ノード。interface
認識できないブロック・タグのツリー・ノードです。interface
認識されないインライン・タグのツリー・ノードです。interface
@uses
ブロック・タグのツリー・ノードです。interface
@value
のインライン・タグのツリー・ノード。interface
@version
ブロック・タグのツリー・ノードです。修飾子と型メソッド説明SnippetTree.getAttributes()
@snippet
タグの属性のリストを返します。StartElementTree.getAttributes()
この要素で定義された属性を返します。DocCommentTree.getBlockTags()
ドキュメント・コメントのブロック・タグを返します。DeprecatedTree.getBody()
アイテムが非推奨になった理由を説明する説明を返します。DocCommentTree.getBody()
ドキュメント・コメントの本文を返します。最初の文の後、およびブロック・タグの前に表示されます。HiddenTree.getBody()
アイテムが非表示になっている理由を説明する説明を返します。SinceTree.getBody()
文書化されている項目の可用性を説明するテキストを返します。VersionTree.getBody()
タグの本文を返します。UnknownBlockTagTree.getContent()
認識されないブロック・タグの内容を返します。UnknownInlineTagTree.getContent()
認識されないインライン・タグのコンテンツを返します。IndexTree.getDescription()
説明(ある場合)を返します。ParamTree.getDescription()
パラメータの説明を返します。ProvidesTree.getDescription()
モジュールによって提供されるサービス・タイプの説明を返します。ReturnTree.getDescription()
メソッドの戻り値の説明を返します。SerialDataTree.getDescription()
シリアル・データの摘要を返します。SerialFieldTree.getDescription()
シリアル・フィールドの説明を返します。SerialTree.getDescription()
フィールドの説明、または"include"または"exclude"という語を返します。ThrowsTree.getDescription()
例外がスローされる理由の説明を返します。UsesTree.getDescription()
モジュール内のサービス・タイプの使用の説明を返します。DocCommentTree.getFirstSentence()
ドキュメント・コメントの最初の文を返します。DocCommentTree.getFullBody()
ドキュメント・コメントの本文全体を返します。最初の文を含むブロック・タグの前に表示されます。LinkTree.getLabel()
リンクのラベル(ある場合)を返します。AuthorTree.getName()
作成者の名前を返します。DocCommentTree.getPostamble()
ドキュメンテーション・コメントの内容に従って、内容(もしあれば)を含むツリーのリストを返します。DocCommentTree.getPreamble()
ドキュメント・コメントの内容に先行するコンテンツ(もしあれば)を含むツリーのリストを返します。SeeTree.getReference()
参照を返します。SummaryTree.getSummary()
コメントの要約または最初の行を返します。SpecTree.getTitle()
タイトルを返します。AttributeTree.getValue()
属性の値を返します。「この属性の種類」がEMPTY
の場合はnull
を返します。 -
com.sun.source.utilでのDocTreeの使用
修飾子と型メソッド説明DocTreeFactory.getFirstSentence
(List<? extends DocTree> list) コンテンツのリストに含まれる最初の文を取得します。DocTrees.getFirstSentence
(List<? extends DocTree> list) コメントの最初の文を表すDocTree
のリストを返します。DocTreePath.iterator()
修飾子と型メソッド説明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) ファイル内のコメント内のツリーの開始位置を返します。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) 指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します単一ノードをスキャンします。単一ノードをスキャンします。final R
ノードのタイプに固有の適切な訪問メソッドを呼び出します。DocTreeScanner.visitOther
(DocTree node, P p) 不明なタイプのDocTree
ノードにビジットします。SimpleDocTreeVisitor.visitOther
(DocTree node, P p) 不明なタイプのDocTree
ノードにビジットします。修飾子と型メソッド説明DocTreeFactory.getFirstSentence
(List<? extends DocTree> list) コンテンツのリストに含まれる最初の文を取得します。DocTrees.getFirstSentence
(List<? extends DocTree> list) コメントの最初の文を表すDocTree
のリストを返します。DocTreeFactory.newAttributeTree
(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) HTML要素またはタグの属性を表す新しいAttributeTree
オブジェクトを作成します。DocTreeFactory.newAuthorTree
(List<? extends DocTree> name) @author
タグを表す新しいAuthorTree
オブジェクトを作成します。DocTreeFactory.newDeprecatedTree
(List<? extends DocTree> text) @deprecated
タグを表す新しいDeprecatedTree
オブジェクトを作成します。DocTreeFactory.newDocCommentTree
(List<? extends DocTree> fullBody, List<? extends DocTree> tags) 完全なドキュメンテーション・コメントを表す新しいDocCommentTree
オブジェクトを作成します。DocTreeFactory.newDocCommentTree
(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) ドキュメンテーション・コメント全体を表す新しいDocCommentTree
オブジェクトを作成します。DocTreeFactory.newExceptionTree
(ReferenceTree name, List<? extends DocTree> description) @exception
タグを表す新しいThrowsTree
オブジェクトを作成します。DocTreeFactory.newHiddenTree
(List<? extends DocTree> text) @hidden
タグを表す新しいHiddenTree
オブジェクトを作成します。DocTreeFactory.newIndexTree
(DocTree term, List<? extends DocTree> description) {@index }
タグを表す新しいIndexTree
オブジェクトを作成します。DocTreeFactory.newLinkPlainTree
(ReferenceTree ref, List<? extends DocTree> label) {@linkplain }
タグを表す新しいLinkTree
オブジェクトを作成します。DocTreeFactory.newLinkTree
(ReferenceTree ref, List<? extends DocTree> label) {@link }
タグを表す新しいLinkTree
オブジェクトを作成します。DocTreeFactory.newParamTree
(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) @param
タグを表す新しいParamTree
オブジェクトを作成します。DocTreeFactory.newProvidesTree
(ReferenceTree name, List<? extends DocTree> description) @provides
タグを表す新しいProvidesTree
オブジェクトを作成します。default ReturnTree
DocTreeFactory.newReturnTree
(boolean isInline, List<? extends DocTree> description) @return
タグまたは{@return}
タグを表す新しいReturnTree
オブジェクトを作成します。DocTreeFactory.newReturnTree
(List<? extends DocTree> description) @return
タグを表す新しいReturnTree
オブジェクトを作成します。DocTreeFactory.newSeeTree
(List<? extends DocTree> reference) @see
タグを表す新しいSeeTree
オブジェクトを作成します。DocTreeFactory.newSerialDataTree
(List<? extends DocTree> description) @serialData
タグを表す新しいSerialDataTree
オブジェクトを作成します。DocTreeFactory.newSerialFieldTree
(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) @serialField
タグを表す新しいSerialFieldTree
オブジェクトを作成します。DocTreeFactory.newSerialTree
(List<? extends DocTree> description) @serial
タグを表す新しいSerialTree
オブジェクトを作成します。DocTreeFactory.newSinceTree
(List<? extends DocTree> text) @since
タグを表す新しいSinceTree
オブジェクトを作成します。DocTreeFactory.newSnippetTree
(List<? extends DocTree> attributes, TextTree text) {@snippet }
タグを表す新しいSnippetTree
オブジェクトを作成します。DocTreeFactory.newSpecTree
(TextTree url, List<? extends DocTree> title) @spec
タグを表す新しいSpecTree
オブジェクトを作成します。DocTreeFactory.newStartElementTree
(Name name, List<? extends DocTree> attrs, boolean selfClosing) HTML要素の開始を表す新しいStartElementTree
オブジェクトを作成します。default SummaryTree
DocTreeFactory.newSummaryTree
(List<? extends DocTree> summary) {@summary }
タグを表す新しいSummaryTree
オブジェクトを作成します。DocTreeFactory.newThrowsTree
(ReferenceTree name, List<? extends DocTree> description) @throws
タグを表す新しいThrowsTree
オブジェクトを作成します。DocTreeFactory.newUnknownBlockTagTree
(Name name, List<? extends DocTree> content) 認識できないブロック・タグを表す新しいUnknownBlockTagTree
オブジェクトを作成します。DocTreeFactory.newUnknownInlineTagTree
(Name name, List<? extends DocTree> content) 認識できないインライン・タグを表す新しいUnknownInlineTagTree
オブジェクトを作成します。DocTreeFactory.newUsesTree
(ReferenceTree name, List<? extends DocTree> description) @uses
タグを表す新しいUsesTree
オブジェクトを作成します。DocTreeFactory.newVersionTree
(List<? extends DocTree> text) {@version }
タグを表す新しいVersionTree
オブジェクトを作成します。一連のノードをスキャンします。final R
各ノードのシーケンスで適切な訪問メソッドを呼び出します。 -
jdk.javadoc.docletでのDocTreeの使用