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要素またはタグの属性を表す新しい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) DOCTYPEHTML宣言を表す新しいDocTypeTreeを作成します。newEndElementTree(Name name) HTML要素の終わりを表す新しいEndElementオブジェクトを作成します。newEntityTree(Name name) HTMLエンティティを表す新しいEntityTreeオブジェクトを作成します。newErroneousTree(String text, Diagnostic<JavaFileObject> diag) 解析不能な入力を表す新しいErroneousTreeオブジェクトを作成します。newEscapeTree(char ch) エスケープされた文字を表す新しいEscapeTreeオブジェクトを作成します。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オブジェクトを作成します。default InheritDocTreenewInheritDocTree(ReferenceTree supertype) {@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 ReturnTreenewReturnTree(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オブジェクトを作成します。newSnippetTree(List<? extends DocTree> attributes, TextTree text) {@snippet }タグを表す新しいSnippetTreeオブジェクトを作成します。newSpecTree(TextTree url, List<? extends DocTree> title) @specタグを表す新しいSpecTreeオブジェクトを作成します。newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) HTML要素の開始を表す新しいStartElementTreeオブジェクトを作成します。default SummaryTreenewSummaryTree(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オブジェクトを作成します。default ValueTreenewValueTree(TextTree format, ReferenceTree ref) {@value }タグを表す新しいValueTreeオブジェクトを作成します。newVersionTree(List<? extends DocTree> text) {@version }タグを表す新しいVersionTreeオブジェクトを作成します。
-
メソッドの詳細
-
newAttributeTree
AttributeTree newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) 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
-
newDocTypeTree
DocTypeTree newDocTypeTree(String text) DOCTYPEHTML宣言を表す新しい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オブジェクト
-
newEscapeTree
EscapeTree newEscapeTree(char ch) エスケープされた文字を表す新しいEscapeTreeオブジェクトを作成します。- APIのノート:
- このメソッド自体は有効なエスケープ・シーケンスのセットを制約しませんが、セットは次のコンテキスト依存エスケープ・シーケンスを含め、「標準ドックレットのドキュメンテーション・コメント仕様」で定義されたエスケープ・シーケンスに効果的に制約できます:
@を表す@@。ブロックまたはインライン・タグの導入として扱われる場合、@/。*/を表す*@/の一部として、/を表します@*。*を表します。この場合、行の先頭にある空白の後に「破棄されました」になります。
- パラメータ:
ch- 文字- 戻り値:
EscapeTreeオブジェクト- 導入されたバージョン:
- 21
-
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
-
newInheritDocTree
InheritDocTree newInheritDocTree(){@inheritDoc}タグを表す新しいInheritDocTreeオブジェクトを作成します。- 戻り値:
InheritDocTreeオブジェクト
-
newInheritDocTree
default InheritDocTree newInheritDocTree(ReferenceTree supertype) {@inheritDoc}タグを表す新しいInheritDocTreeオブジェクトを作成します。- 実装要件:
- この実装は
UnsupportedOperationExceptionをスローします。 - パラメータ:
supertype- スーパークラスまたはスーパー・インタフェース参照- 戻り値:
InheritDocTreeオブジェクト- 導入されたバージョン:
- 22
-
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、それ以外の場合はfalsename- 説明されているパラメータ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、それ以外の場合はfalsedescription- メソッドの戻り値の説明- 戻り値:
ReturnTreeオブジェクト- 例外:
UnsupportedOperationException- インライン{@return}タグがサポートされていない場合- 導入されたバージョン:
- 16
-
newSeeTree
-
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
-
newSnippetTree
SnippetTree newSnippetTree(List<? extends DocTree> attributes, TextTree text) {@snippet }タグを表す新しいSnippetTreeオブジェクトを作成します。- パラメータ:
attributes- タグの属性text- タグの本文、またはタグに本文(空の本文と混同しない)がない場合はnull- 戻り値:
SnippetTreeオブジェクト- 導入されたバージョン:
- 18
-
newSpecTree
-
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
-
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オブジェクト
-
newValueTree
default ValueTree newValueTree(TextTree format, ReferenceTree ref) {@value }タグを表す新しいValueTreeオブジェクトを作成します。- 実装要件:
- この実装は
newValueTree(ref)を呼び出します。 - パラメータ:
format- 値の書式文字列ref- 値への参照- 戻り値:
ValueTreeオブジェクト- 導入されたバージョン:
- 20
-
newVersionTree
VersionTree newVersionTree(List<? extends DocTree> text) {@version }タグを表す新しいVersionTreeオブジェクトを作成します。- パラメータ:
text- タグの内容- 戻り値:
VersionTreeオブジェクト
-
at
DocTreeFactory at(int pos) このファクトリによって作成される後続のツリー・ノードに記録される位置を設定します。 位置は、ソース・ファイルまたはNOPOSの先頭からの文字オフセットでなければなりません。- パラメータ:
pos- 位置- 戻り値:
- このオブジェクト、メソッドの連鎖を容易にするため
-
getFirstSentence
コンテンツのリストに含まれる最初の文を取得します。 最初の文の決定は実装固有であり、ロケール固有のBreakIteratorおよびその他のヒューリスティックの使用が含まれる場合があります。 結果のリストは、入力リストと共通の初期項目のセットを共有できます。- パラメータ:
list- リスト- 戻り値:
- リストの最初の文を含むリスト
-