public interface DocTreeFactory
DocTree
ノードを作成するためのファクトリ。- 実装上のノート:
- このインタフェースの実装におけるメソッドは、同じ実装によって作成された
DocTree
ノードのみを受け入れることができます。 - 導入されたバージョン:
- 9
-
メソッドのサマリー
修飾子と型メソッド説明at
(int pos) このファクトリによって作成される後続のツリー・ノードに記録される位置を設定します。getFirstSentence
(List<? extends DocTree> list) コンテンツのリストに含まれる最初の文を取得します。newAttributeTree
(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) HTMLタグのHTML属性を表す新しいAttributeTree
オブジェクトを作成します。newAuthorTree
(List<? extends DocTree> name) @author
タグを表す新しいAuthorTree
オブジェクトを作成します。newCodeTree
(TextTree text) {@code }
タグを表す新しいLiteralTree
オブジェクトを作成します。newCommentTree
(String text) HTMLコメントを表す新しいCommentTree
を作成します。newDeprecatedTree
(List<? extends DocTree> text) @deprecated
タグを表す新しいDeprecatedTree
オブジェクトを作成します。newDocCommentTree
(List<? extends DocTree> fullBody, List<? extends DocTree> tags) 完全なドキュメンテーション・コメントを表す新しいDocCommentTree
オブジェクトを作成します。newDocCommentTree
(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) ドキュメンテーション・コメント全体を表す新しいDocCommentTree
オブジェクトを作成します。{@docRoot}
タグを表す新しいDocRootTree
オブジェクトを作成します。newDocTypeTree
(String text) DOCTYPE
HTML宣言を表す新しいDocTypeTree
を作成します。newEndElementTree
(Name name) HTML要素の終わりを表す新しいEndElement
オブジェクトを作成します。newEntityTree
(Name name) HTMLエンティティを表す新しいEntityTree
オブジェクトを作成します。newErroneousTree
(String text, Diagnostic<JavaFileObject> diag) 解析不能な入力を表す新しいErroneousTree
オブジェクトを作成します。newExceptionTree
(ReferenceTree name, List<? extends DocTree> description) @exception
タグを表す新しいThrowsTree
オブジェクトを作成します。newHiddenTree
(List<? extends DocTree> text) @hidden
タグを表す新しいHiddenTree
オブジェクトを作成します。newIdentifierTree
(Name name) @param
タグなどの識別子を表す新しいIdentifierTree
オブジェクトを作成します。newIndexTree
(DocTree term, List<? extends DocTree> description) {@index }
タグを表す新しいIndexTree
オブジェクトを作成します。{@inheritDoc}
タグを表す新しいInheritDocTree
オブジェクトを作成します。newLinkPlainTree
(ReferenceTree ref, List<? extends DocTree> label) {@linkplain }
タグを表す新しいLinkTree
オブジェクトを作成します。newLinkTree
(ReferenceTree ref, List<? extends DocTree> label) {@link }
タグを表す新しいLinkTree
オブジェクトを作成します。newLiteralTree
(TextTree text) {@literal }
タグを表す新しいLiteralTree
オブジェクトを作成します。newParamTree
(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) @param
タグを表す新しいParamTree
オブジェクトを作成します。newProvidesTree
(ReferenceTree name, List<? extends DocTree> description) @provides
タグを表す新しいProvidesTree
オブジェクトを作成します。newReferenceTree
(String signature) API要素への参照を表す新しいReferenceTree
オブジェクトを作成します。default ReturnTree
newReturnTree
(boolean isInline, List<? extends DocTree> description) @return
タグまたは{@return}
タグを表す新しいReturnTree
オブジェクトを作成します。newReturnTree
(List<? extends DocTree> description) @return
タグを表す新しいReturnTree
オブジェクトを作成します。newSeeTree
(List<? extends DocTree> reference) @see
タグを表す新しいSeeTree
オブジェクトを作成します。newSerialDataTree
(List<? extends DocTree> description) @serialData
タグを表す新しいSerialDataTree
オブジェクトを作成します。newSerialFieldTree
(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) @serialField
タグを表す新しいSerialFieldTree
オブジェクトを作成します。newSerialTree
(List<? extends DocTree> description) @serial
タグを表す新しいSerialTree
オブジェクトを作成します。newSinceTree
(List<? extends DocTree> text) @since
タグを表す新しいSinceTree
オブジェクトを作成します。newStartElementTree
(Name name, List<? extends DocTree> attrs, boolean selfClosing) HTML要素の開始を表す新しいStartElementTree
オブジェクトを作成します。default SummaryTree
newSummaryTree
(List<? extends DocTree> summary) {@summary }
タグを表す新しいSummaryTree
オブジェクトを作成します。newSystemPropertyTree
(Name propertyName) {@systemProperty }
タグを表す新しいSystemPropertyTree
オブジェクトを作成します。newTextTree
(String text) プレーン・テキストを表す新しいTextTree
オブジェクトを作成します。newThrowsTree
(ReferenceTree name, List<? extends DocTree> description) @throws
タグを表す新しいThrowsTree
オブジェクトを作成します。newUnknownBlockTagTree
(Name name, List<? extends DocTree> content) 認識できないブロック・タグを表す新しいUnknownBlockTagTree
オブジェクトを作成します。newUnknownInlineTagTree
(Name name, List<? extends DocTree> content) 認識できないインライン・タグを表す新しいUnknownInlineTagTree
オブジェクトを作成します。newUsesTree
(ReferenceTree name, List<? extends DocTree> description) @uses
タグを表す新しいUsesTree
オブジェクトを作成します。{@value }
タグを表す新しいValueTree
オブジェクトを作成します。newVersionTree
(List<? extends DocTree> text) {@version }
タグを表す新しいVersionTree
オブジェクトを作成します。
-
メソッドの詳細
-
newAttributeTree
AttributeTree newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) HTMLタグのHTML属性を表す新しいAttributeTree
オブジェクトを作成します。- パラメータ:
name
- 属性の名前vkind
- 属性値の種類value
- 属性の値(存在する場合)- 戻り値:
AttributeTree
オブジェクト
-
newAuthorTree
AuthorTree newAuthorTree(List<? extends DocTree> name) @author
タグを表す新しいAuthorTree
オブジェクトを作成します。- パラメータ:
name
- 著者の名前- 戻り値:
AuthorTree
オブジェクト
-
newCodeTree
LiteralTree newCodeTree(TextTree text) {@code }
タグを表す新しいLiteralTree
オブジェクトを作成します。- パラメータ:
text
- タグの内容- 戻り値:
LiteralTree
オブジェクト
-
newCommentTree
CommentTree newCommentTree(String text) HTMLコメントを表す新しいCommentTree
を作成します。- パラメータ:
text
- コメントの内容- 戻り値:
CommentTree
オブジェクト
-
newDeprecatedTree
DeprecatedTree newDeprecatedTree(List<? extends DocTree> text) @deprecated
タグを表す新しいDeprecatedTree
オブジェクトを作成します。- パラメータ:
text
- タグの内容- 戻り値:
DeprecatedTree
オブジェクト
-
newDocCommentTree
DocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags) 完全なドキュメンテーション・コメントを表す新しいDocCommentTree
オブジェクトを作成します。- パラメータ:
fullBody
- ドキュメンテーション全体のコメントtags
- ドキュメンテーション・コメント内のブロック・タグ- 戻り値:
DocCommentTree
オブジェクト
-
newDocCommentTree
DocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) ドキュメンテーション・コメント全体を表す新しいDocCommentTree
オブジェクトを作成します。- パラメータ:
fullBody
- ドキュメンテーション全体のコメントtags
- ドキュメンテーション・コメント内のブロック・タグpreamble
- bodyタグを含むhtmlファイルのメタ・コンテンツpostamble
- 閉じたbodyタグを含むhtmlのメタ・コンテンツ- 戻り値:
DocCommentTree
オブジェクト- 導入されたバージョン:
- 10
-
newDocRootTree
DocRootTree newDocRootTree(){@docRoot}
タグを表す新しいDocRootTree
オブジェクトを作成します。- 戻り値:
DocRootTree
オブジェクト
-
newDocTypeTree
DocTypeTree newDocTypeTree(String text) DOCTYPE
HTML宣言を表す新しいDocTypeTree
を作成します。- パラメータ:
text
- 宣言の内容- 戻り値:
DocTypeTree
オブジェクト- 導入されたバージョン:
- 10
-
newEndElementTree
EndElementTree newEndElementTree(Name name) HTML要素の終わりを表す新しいEndElement
オブジェクトを作成します。- パラメータ:
name
- HTML要素の名前- 戻り値:
EndElementTree
オブジェクト
-
newEntityTree
EntityTree newEntityTree(Name name) HTMLエンティティを表す新しいEntityTree
オブジェクトを作成します。- パラメータ:
name
- エンティティの名前。'&'と';'の間の文字をHTMLドキュメント内のエンティティの表現で表します- 戻り値:
EntityTree
オブジェクト
-
newErroneousTree
ErroneousTree newErroneousTree(String text, Diagnostic<JavaFileObject> diag) 解析不能な入力を表す新しいErroneousTree
オブジェクトを作成します。- パラメータ:
text
- 解析不能なテキストdiag
- 解析不能なテキストに関連付けられた診断、またはnull
- 戻り値:
ErroneousTree
オブジェクト
-
newExceptionTree
ThrowsTree newExceptionTree(ReferenceTree name, List<? extends DocTree> description) @exception
タグを表す新しいThrowsTree
オブジェクトを作成します。- パラメータ:
name
- 例外の名前description
- 例外がスローされる理由の説明- 戻り値:
ThrowsTree
オブジェクト
-
newHiddenTree
HiddenTree newHiddenTree(List<? extends DocTree> text) @hidden
タグを表す新しいHiddenTree
オブジェクトを作成します。- パラメータ:
text
- タグの内容- 戻り値:
HiddenTree
オブジェクト
-
newIdentifierTree
IdentifierTree newIdentifierTree(Name name) @param
タグなどの識別子を表す新しいIdentifierTree
オブジェクトを作成します。- パラメータ:
name
- 識別子の名前- 戻り値:
IdentifierTree
オブジェクト
-
newIndexTree
{@index }
タグを表す新しいIndexTree
オブジェクトを作成します。- パラメータ:
term
- 検索語description
- 検索語のオプションの説明- 戻り値:
IndexTree
オブジェクト
-
newInheritDocTree
InheritDocTree newInheritDocTree(){@inheritDoc}
タグを表す新しいInheritDocTree
オブジェクトを作成します。- 戻り値:
InheritDocTree
オブジェクト
-
newLinkTree
LinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label) {@link }
タグを表す新しいLinkTree
オブジェクトを作成します。- パラメータ:
ref
- 参照されているAPI要素label
- リンクのオプションのラベル- 戻り値:
LinkTree
オブジェクト
-
newLinkPlainTree
LinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label) {@linkplain }
タグを表す新しいLinkTree
オブジェクトを作成します。- パラメータ:
ref
- 参照されているAPI要素label
- リンクのオプションのラベル- 戻り値:
LinkTree
オブジェクト
-
newLiteralTree
LiteralTree newLiteralTree(TextTree text) {@literal }
タグを表す新しいLiteralTree
オブジェクトを作成します。- パラメータ:
text
- タグの内容- 戻り値:
LiteralTree
オブジェクト
-
newParamTree
ParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) @param
タグを表す新しいParamTree
オブジェクトを作成します。- パラメータ:
isTypeParameter
- これが型パラメータの場合はtrue
、それ以外の場合はfalse
name
- 説明されているパラメータdescription
- パラメータの説明- 戻り値:
ParamTree
オブジェクト
-
newProvidesTree
ProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description) @provides
タグを表す新しいProvidesTree
オブジェクトを作成します。- パラメータ:
name
- サービス型の名前description
- 提供されているサービスの説明- 戻り値:
ProvidesTree
オブジェクト
-
newReferenceTree
ReferenceTree newReferenceTree(String signature) API要素への参照を表す新しいReferenceTree
オブジェクトを作成します。- パラメータ:
signature
- 参照のdocコメント・シグネチャ- 戻り値:
ReferenceTree
オブジェクト
-
newReturnTree
ReturnTree newReturnTree(List<? extends DocTree> description) @return
タグを表す新しいReturnTree
オブジェクトを作成します。- パラメータ:
description
- メソッドの戻り値の説明- 戻り値:
ReturnTree
オブジェクト
-
newReturnTree
default ReturnTree newReturnTree(boolean isInline, List<? extends DocTree> description) @return
タグまたは{@return}
タグを表す新しいReturnTree
オブジェクトを作成します。- 実装要件:
- この実装は、
isInline
がtrue
の場合はUnsupportedOperationException
をスローし、それ以外の場合はnewReturnTree(List)
をコールします。 - パラメータ:
isInline
- このインスタンスがインライン・タグの場合はtrue
、それ以外の場合はfalse
description
- メソッドの戻り値の説明- 戻り値:
ReturnTree
オブジェクト- 例外:
UnsupportedOperationException
- インライン{@return}
タグがサポートされていない場合- 導入されたバージョン:
- 16
-
newSeeTree
@see
タグを表す新しいSeeTree
オブジェクトを作成します。- パラメータ:
reference
- リファレンス- 戻り値:
SeeTree
オブジェクト
-
newSerialTree
SerialTree newSerialTree(List<? extends DocTree> description) @serial
タグを表す新しいSerialTree
オブジェクトを作成します。- パラメータ:
description
- タグの説明- 戻り値:
SerialTree
オブジェクト
-
newSerialDataTree
SerialDataTree newSerialDataTree(List<? extends DocTree> description) @serialData
タグを表す新しいSerialDataTree
オブジェクトを作成します。- パラメータ:
description
- タグの説明- 戻り値:
SerialDataTree
オブジェクト
-
newSerialFieldTree
SerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) @serialField
タグを表す新しいSerialFieldTree
オブジェクトを作成します。- パラメータ:
name
- フィールドの名前type
- フィールドの型description
- フィールドの説明- 戻り値:
SerialFieldTree
オブジェクト
-
newSinceTree
@since
タグを表す新しいSinceTree
オブジェクトを作成します。- パラメータ:
text
- タグの内容- 戻り値:
SinceTree
オブジェクト
-
newStartElementTree
StartElementTree newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) HTML要素の開始を表す新しいStartElementTree
オブジェクトを作成します。- パラメータ:
name
- HTML要素の名前attrs
- 属性selfClosing
- 開始要素が自己終了としてマークされている場合はtrue
、そうでない場合はfalse
- 戻り値:
StartElementTree
オブジェクト
-
newSummaryTree
default SummaryTree newSummaryTree(List<? extends DocTree> summary) {@summary }
タグを表す新しいSummaryTree
オブジェクトを作成します。- 実装要件:
- この実装は
UnsupportedOperationException
をスローします。 - パラメータ:
summary
- タグの内容- 戻り値:
SummaryTree
オブジェクト- 導入されたバージョン:
- 10
-
newSystemPropertyTree
SystemPropertyTree newSystemPropertyTree(Name propertyName) {@systemProperty }
タグを表す新しいSystemPropertyTree
オブジェクトを作成します。- パラメータ:
propertyName
- システム・プロパティ名- 戻り値:
SystemPropertyTree
オブジェクト- 導入されたバージョン:
- 12
-
newTextTree
プレーン・テキストを表す新しいTextTree
オブジェクトを作成します。- パラメータ:
text
- テキスト- 戻り値:
TextTree
オブジェクト
-
newThrowsTree
ThrowsTree newThrowsTree(ReferenceTree name, List<? extends DocTree> description) @throws
タグを表す新しいThrowsTree
オブジェクトを作成します。- パラメータ:
name
- 例外の名前description
- 例外がスローされる理由の説明- 戻り値:
ThrowsTree
オブジェクト
-
newUnknownBlockTagTree
UnknownBlockTagTree newUnknownBlockTagTree(Name name, List<? extends DocTree> content) 認識できないブロック・タグを表す新しいUnknownBlockTagTree
オブジェクトを作成します。- パラメータ:
name
- ブロック・タグの名前content
- コンテンツ- 戻り値:
UnknownBlockTagTree
オブジェクト
-
newUnknownInlineTagTree
UnknownInlineTagTree newUnknownInlineTagTree(Name name, List<? extends DocTree> content) 認識できないインライン・タグを表す新しいUnknownInlineTagTree
オブジェクトを作成します。- パラメータ:
name
- インライン・タグの名前content
- コンテンツ- 戻り値:
UnknownInlineTagTree
オブジェクト
-
newUsesTree
UsesTree newUsesTree(ReferenceTree name, List<? extends DocTree> description) @uses
タグを表す新しいUsesTree
オブジェクトを作成します。- パラメータ:
name
- サービス型の名前description
- サービスの使用方法の説明- 戻り値:
UsesTree
オブジェクト
-
newValueTree
ValueTree newValueTree(ReferenceTree ref) {@value }
タグを表す新しいValueTree
オブジェクトを作成します。- パラメータ:
ref
- 値への参照- 戻り値:
ValueTree
オブジェクト
-
newVersionTree
VersionTree newVersionTree(List<? extends DocTree> text) {@version }
タグを表す新しいVersionTree
オブジェクトを作成します。- パラメータ:
text
- タグの内容- 戻り値:
VersionTree
オブジェクト
-
at
DocTreeFactory at(int pos) このファクトリによって作成される後続のツリー・ノードに記録される位置を設定します。 位置は、ソース・ファイルまたはNOPOS
の先頭からの文字オフセットでなければなりません。- パラメータ:
pos
- 位置- 戻り値:
- このオブジェクトは、メソッドの連鎖を容易にします
-
getFirstSentence
コンテンツのリストに含まれる最初の文を取得します。 最初の文の決定は実装固有のものであり、ロケール固有のBreakIterator
やその他のヒューリスティックを使用する必要があります。 結果リストは、入力リストと共通の初期アイテム・セットを共有することができます。- パラメータ:
list
- リスト- 戻り値:
- リストの最初の文を含むリスト
-