- 
 public interface DocTreeFactoryDocTreeノードを作成するためのファクトリ。- 実装上の注意:
- このインタフェースの実装におけるメソッドは、同じ実装によって作成されたDocTreeノードのみを受け入れることができます。
- 導入されたバージョン:
- 9
 
- 
- 
メソッドのサマリー修飾子と型 メソッド 説明 DocTreeFactoryat(int pos)このファクトリで作成された後続のツリー・ノードに記録される位置を設定します。List<DocTree>getFirstSentence(List<? extends DocTree> list)コンテンツのリストに含まれる最初の文を取得します。AttributeTreenewAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)新しいAttributeTreeオブジェクトを作成し、HTMLタグのHTML属性を表します。AuthorTreenewAuthorTree(List<? extends DocTree> name)新しいAuthorTreeオブジェクトを作成し、{@author }タグを表します。LiteralTreenewCodeTree(TextTree text)新しいCodeTreeオブジェクトを作成し、{@code }タグを表します。CommentTreenewCommentTree(String text)HTMLコメントを表す新しいCommentTreeを作成します。DeprecatedTreenewDeprecatedTree(List<? extends DocTree> text)新しいDeprecatedTreeオブジェクトを作成し、{@deprecated }タグを表します。DocCommentTreenewDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)完全なドキュメント・コメントを表すために、新しいDocCommentTreeオブジェクトを作成します。DocCommentTreenewDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)新しいDocCommentTreeオブジェクトを作成して、enitireのドキュメント・コメントを表現します。DocRootTreenewDocRootTree()新しいDocRootTreeオブジェクトを作成し、{@docroot}タグを表します。DocTypeTreenewDocTypeTree(String text)新しいDocTypeTreeを作成して、DOCTYPEHTML宣言を表現します。EndElementTreenewEndElementTree(Name name)新しいEndElementオブジェクトを作成し、HTML要素の終わりを表します。EntityTreenewEntityTree(Name name)HTMLエンティティを表す新しいEntityTreeオブジェクトを作成します。ErroneousTreenewErroneousTree(String text, Diagnostic<JavaFileObject> diag)新しいErroneousTreeオブジェクトを作成して、解析不可能な入力を表現します。ThrowsTreenewExceptionTree(ReferenceTree name, List<? extends DocTree> description)新しいExceptionTreeオブジェクトを作成し、@exceptionタグを表します。HiddenTreenewHiddenTree(List<? extends DocTree> text)新しいHiddenTreeオブジェクトを作成し、{@hidden }タグを表します。IdentifierTreenewIdentifierTree(Name name)新しいIdentifierTreeオブジェクトを作成し、@paramタグなどの識別子を表します。IndexTreenewIndexTree(DocTree term, List<? extends DocTree> description)新しいIndexTreeオブジェクトを作成し、{@index }タグを表します。InheritDocTreenewInheritDocTree()新しいInheritDocTreeオブジェクトを作成し、{@inheritDoc}タグを表します。LinkTreenewLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)新しいLinkPlainTreeオブジェクトを作成し、{@linkplain }タグを表します。LinkTreenewLinkTree(ReferenceTree ref, List<? extends DocTree> label)新しいLinkTreeオブジェクトを作成し、{@link }タグを表します。LiteralTreenewLiteralTree(TextTree text)新しいLiteralTreeオブジェクトを作成し、{@literal }タグを表します。ParamTreenewParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)新しいParamTreeオブジェクトを作成し、@paramタグを表します。ProvidesTreenewProvidesTree(ReferenceTree name, List<? extends DocTree> description)新しいProvidesTreeオブジェクトを作成し、@providesタグを表します。ReferenceTreenewReferenceTree(String signature)新しいReferenceTreeオブジェクトを作成し、API要素への参照を表します。ReturnTreenewReturnTree(List<? extends DocTree> description)新しいReturnTreeオブジェクトを作成し、@returnタグを表します。SeeTreenewSeeTree(List<? extends DocTree> reference)新しいSeeTreeオブジェクトを作成し、@seeタグを表します。SerialDataTreenewSerialDataTree(List<? extends DocTree> description)新しいSerialDataTreeオブジェクトを作成し、@serialDataタグを表します。SerialFieldTreenewSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)新しいSerialFieldTreeオブジェクトを作成し、@serialFieldタグを表します。SerialTreenewSerialTree(List<? extends DocTree> description)新しいSerialTreeオブジェクトを作成し、@serialタグを表します。SinceTreenewSinceTree(List<? extends DocTree> text)新しいSinceTreeオブジェクトを作成し、@sinceタグを表します。StartElementTreenewStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)新しいStartElementTreeオブジェクトを作成して、HTML要素の開始点を表します。default SummaryTreenewSummaryTree(List<? extends DocTree> summary)新しいSummaryTreeオブジェクトを作成して、@summaryタグを表現します。SystemPropertyTreenewSystemPropertyTree(Name propertyName)新しいSystemPropertyTreeオブジェクトを作成して、{@systemProperty }タグを表現します。TextTreenewTextTree(String text)新しいTextTreeオブジェクトを作成して、プレーンテキストを表現します。ThrowsTreenewThrowsTree(ReferenceTree name, List<? extends DocTree> description)新しいThrowsTreeオブジェクトを作成し、@throwsタグを表します。UnknownBlockTagTreenewUnknownBlockTagTree(Name name, List<? extends DocTree> content)認識できないブロック・タグを表す新しいUnknownBlockTagTreeオブジェクトを作成します。UnknownInlineTagTreenewUnknownInlineTagTree(Name name, List<? extends DocTree> content)認識できないインライン・タグを表す新しいUnknownInlineTagTreeオブジェクトを作成します。UsesTreenewUsesTree(ReferenceTree name, List<? extends DocTree> description)新しいUsesTreeオブジェクトを作成し、@usesタグを表します。ValueTreenewValueTree(ReferenceTree ref)新しいValueTreeオブジェクトを作成し、{@value }タグを表します。VersionTreenewVersionTree(List<? extends DocTree> text)新しいVersionTreeオブジェクトを作成し、{@version }タグを表します。
 
- 
- 
- 
メソッドの詳細- 
newAttributeTreeAttributeTree newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) 新しいAttributeTreeオブジェクトを作成し、HTMLタグのHTML属性を表します。- パラメータ:
- name- 属性の名前
- vkind- 属性値の種類
- value- 属性の値(存在する場合)
- 戻り値:
- AttributeTreeオブジェクト
 
 - 
newAuthorTreeAuthorTree newAuthorTree(List<? extends DocTree> name) 新しいAuthorTreeオブジェクトを作成し、{@author }タグを表します。- パラメータ:
- name- 著者の名前
- 戻り値:
- AuthorTreeオブジェクト
 
 - 
newCodeTreeLiteralTree newCodeTree(TextTree text) 新しいCodeTreeオブジェクトを作成し、{@code }タグを表します。- パラメータ:
- text- タグの内容
- 戻り値:
- CodeTreeオブジェクト
 
 - 
newCommentTreeCommentTree newCommentTree(String text) HTMLコメントを表す新しいCommentTreeを作成します。- パラメータ:
- text- コメントの内容
- 戻り値:
- CommentTreeオブジェクト
 
 - 
newDeprecatedTreeDeprecatedTree newDeprecatedTree(List<? extends DocTree> text) 新しいDeprecatedTreeオブジェクトを作成し、{@deprecated }タグを表します。- パラメータ:
- text- タグの内容
- 戻り値:
- DeprecatedTreeオブジェクト
 
 - 
newDocCommentTreeDocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags) 完全なドキュメント・コメントを表すために、新しいDocCommentTreeオブジェクトを作成します。- パラメータ:
- fullBody- ドキュメンテーション全体のコメント
- tags- ドキュメンテーション・コメント内のブロック・タグ
- 戻り値:
- DocCommentTreeオブジェクト
 
 - 
newDocCommentTreeDocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) 新しいDocCommentTreeオブジェクトを作成して、enitireのドキュメント・コメントを表現します。- パラメータ:
- fullBody- ドキュメンテーション全体のコメント
- tags- ドキュメンテーション・コメント内のブロック・タグ
- preamble- bodyタグを含むhtmlファイルのメタ・コンテンツ
- postamble- 閉じたbodyタグを含むhtmlのメタ・コンテンツ
- 戻り値:
- DocCommentTreeオブジェクト
- 導入されたバージョン:
- 10
 
 - 
newDocRootTreeDocRootTree newDocRootTree() 新しいDocRootTreeオブジェクトを作成し、{@docroot}タグを表します。- 戻り値:
- DocRootTreeオブジェクト
 
 - 
newDocTypeTreeDocTypeTree newDocTypeTree(String text) 新しいDocTypeTreeを作成して、DOCTYPEHTML宣言を表現します。- パラメータ:
- text- 宣言の内容
- 戻り値:
- CommentTreeオブジェクト
- 導入されたバージョン:
- 10
 
 - 
newEndElementTreeEndElementTree newEndElementTree(Name name) 新しいEndElementオブジェクトを作成し、HTML要素の終わりを表します。- パラメータ:
- name- HTML要素の名前
- 戻り値:
- EndElementTreeオブジェクト
 
 - 
newEntityTreeEntityTree newEntityTree(Name name) HTMLエンティティを表す新しいEntityTreeオブジェクトを作成します。- パラメータ:
- name- '<'と';'の間の文字を表すエンティティの名前。
- 戻り値:
- EntityTreeオブジェクト
 
 - 
newErroneousTreeErroneousTree newErroneousTree(String text, Diagnostic<JavaFileObject> diag) 新しいErroneousTreeオブジェクトを作成して、解析不可能な入力を表現します。- パラメータ:
- text- 解析不能なテキスト
- diag- 解析不能なテキストに関連付けられた診断、またはnull
- 戻り値:
- ErroneousTreeオブジェクト
 
 - 
newExceptionTreeThrowsTree newExceptionTree(ReferenceTree name, List<? extends DocTree> description) 新しいExceptionTreeオブジェクトを作成し、@exceptionタグを表します。- パラメータ:
- name- 例外の名前
- description- 例外がスローされる理由の説明
- 戻り値:
- ExceptionTreeオブジェクト
 
 - 
newHiddenTreeHiddenTree newHiddenTree(List<? extends DocTree> text) 新しいHiddenTreeオブジェクトを作成し、{@hidden }タグを表します。- パラメータ:
- text- タグの内容
- 戻り値:
- HiddenTreeオブジェクト
 
 - 
newIdentifierTreeIdentifierTree newIdentifierTree(Name name) 新しいIdentifierTreeオブジェクトを作成し、@paramタグなどの識別子を表します。- パラメータ:
- name- 識別子の名前
- 戻り値:
- IdentifierTreeオブジェクト
 
 - 
newIndexTreeIndexTree newIndexTree(DocTree term, List<? extends DocTree> description) 新しいIndexTreeオブジェクトを作成し、{@index }タグを表します。- パラメータ:
- term- 検索語
- description- 検索語のオプションの説明
- 戻り値:
- IndexTreeオブジェクト
 
 - 
newInheritDocTreeInheritDocTree newInheritDocTree() 新しいInheritDocTreeオブジェクトを作成し、{@inheritDoc}タグを表します。- 戻り値:
- InheritDocTreeオブジェクト
 
 - 
newLinkTreeLinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label) 新しいLinkTreeオブジェクトを作成し、{@link }タグを表します。- パラメータ:
- ref- 参照されているAPI要素
- label- リンクのオプションのラベル
- 戻り値:
- LinkTreeオブジェクト
 
 - 
newLinkPlainTreeLinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label) 新しいLinkPlainTreeオブジェクトを作成し、{@linkplain }タグを表します。- パラメータ:
- ref- 参照されているAPI要素
- label- リンクのオプションのラベル
- 戻り値:
- LinkPlainTreeオブジェクト
 
 - 
newLiteralTreeLiteralTree newLiteralTree(TextTree text) 新しいLiteralTreeオブジェクトを作成し、{@literal }タグを表します。- パラメータ:
- text- タグの内容
- 戻り値:
- LiteralTreeオブジェクト
 
 - 
newParamTreeParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) 新しいParamTreeオブジェクトを作成し、@paramタグを表します。- パラメータ:
- isTypeParameter- これが型パラメータの場合はtrue、そうでない場合はfalse
- name- 説明されているパラメータ
- description- パラメータの説明
- 戻り値:
- ParamTreeオブジェクト
 
 - 
newProvidesTreeProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description) 新しいProvidesTreeオブジェクトを作成し、@providesタグを表します。- パラメータ:
- name- サービス型の名前
- description- 提供されているサービスの説明
- 戻り値:
- ProvidesTreeオブジェクト
 
 - 
newReferenceTreeReferenceTree newReferenceTree(String signature) 新しいReferenceTreeオブジェクトを作成し、API要素への参照を表します。- パラメータ:
- signature- 参照のdocコメント・シグネチャ
- 戻り値:
- ReferenceTreeオブジェクト
 
 - 
newReturnTreeReturnTree newReturnTree(List<? extends DocTree> description) 新しいReturnTreeオブジェクトを作成し、@returnタグを表します。- パラメータ:
- description- メソッドの戻り値の説明
- 戻り値:
- ReturnTreeオブジェクト
 
 - 
newSeeTreeSeeTree newSeeTree(List<? extends DocTree> reference) 新しいSeeTreeオブジェクトを作成し、@seeタグを表します。- パラメータ:
- reference- リファレンス
- 戻り値:
- SeeTreeオブジェクト
 
 - 
newSerialTreeSerialTree newSerialTree(List<? extends DocTree> description) 新しいSerialTreeオブジェクトを作成し、@serialタグを表します。- パラメータ:
- description- タグの説明
- 戻り値:
- SerialTreeオブジェクト
 
 - 
newSerialDataTreeSerialDataTree newSerialDataTree(List<? extends DocTree> description) 新しいSerialDataTreeオブジェクトを作成し、@serialDataタグを表します。- パラメータ:
- description- タグの説明
- 戻り値:
- SerialDataTreeオブジェクト
 
 - 
newSerialFieldTreeSerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) 新しいSerialFieldTreeオブジェクトを作成し、@serialFieldタグを表します。- パラメータ:
- name- フィールドの名前
- type- フィールドの型
- description- フィールドの説明
- 戻り値:
- SerialFieldTreeオブジェクト
 
 - 
newSinceTreeSinceTree newSinceTree(List<? extends DocTree> text) 新しいSinceTreeオブジェクトを作成し、@sinceタグを表します。- パラメータ:
- text- タグの内容
- 戻り値:
- SinceTreeオブジェクト
 
 - 
newStartElementTreeStartElementTree newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) 新しいStartElementTreeオブジェクトを作成して、HTML要素の開始点を表します。- パラメータ:
- name- HTML要素の名前
- attrs- 属性
- selfClosing- 開始要素が自己終了としてマークされている場合はtrue; そうでない場合はfalse
- 戻り値:
- StartElementTreeオブジェクト
 
 - 
newSummaryTreedefault SummaryTree newSummaryTree(List<? extends DocTree> summary) 新しいSummaryTreeオブジェクトを作成して、@summaryタグを表現します。- 実装要件:
- この実装はUnsupportedOperationExceptionをスローします。
- パラメータ:
- summary- タグの内容
- 戻り値:
- SummaryTreeオブジェクト
- 導入されたバージョン:
- 10
 
 - 
newSystemPropertyTreeSystemPropertyTree newSystemPropertyTree(Name propertyName) 新しいSystemPropertyTreeオブジェクトを作成して、{@systemProperty }タグを表現します。- パラメータ:
- propertyName- システム・プロパティ名
- 戻り値:
- SystemPropertyTreeオブジェクト
- 導入されたバージョン:
- 12
 
 - 
newTextTreeTextTree newTextTree(String text) 新しいTextTreeオブジェクトを作成して、プレーンテキストを表現します。- パラメータ:
- text- テキスト
- 戻り値:
- TextTreeオブジェクト
 
 - 
newThrowsTreeThrowsTree newThrowsTree(ReferenceTree name, List<? extends DocTree> description) 新しいThrowsTreeオブジェクトを作成し、@throwsタグを表します。- パラメータ:
- name- 例外の名前
- description- 例外がスローされる理由の説明
- 戻り値:
- ThrowsTreeオブジェクト
 
 - 
newUnknownBlockTagTreeUnknownBlockTagTree newUnknownBlockTagTree(Name name, List<? extends DocTree> content) 認識できないブロック・タグを表す新しいUnknownBlockTagTreeオブジェクトを作成します。- パラメータ:
- name- ブロック・タグの名前
- content- コンテンツ
- 戻り値:
- UnknownBlockTagTreeオブジェクト
 
 - 
newUnknownInlineTagTreeUnknownInlineTagTree newUnknownInlineTagTree(Name name, List<? extends DocTree> content) 認識できないインライン・タグを表す新しいUnknownInlineTagTreeオブジェクトを作成します。- パラメータ:
- name- インライン・タグの名前
- content- コンテンツ
- 戻り値:
- UnknownInlineTagTreeオブジェクト
 
 - 
newUsesTreeUsesTree newUsesTree(ReferenceTree name, List<? extends DocTree> description) 新しいUsesTreeオブジェクトを作成し、@usesタグを表します。- パラメータ:
- name- サービス型の名前
- description- サービスの使用方法の説明
- 戻り値:
- UsesTreeオブジェクト
 
 - 
newValueTreeValueTree newValueTree(ReferenceTree ref) 新しいValueTreeオブジェクトを作成し、{@value }タグを表します。- パラメータ:
- ref- 値への参照
- 戻り値:
- ValueTreeオブジェクト
 
 - 
newVersionTreeVersionTree newVersionTree(List<? extends DocTree> text) 新しいVersionTreeオブジェクトを作成し、{@version }タグを表します。- パラメータ:
- text- タグの内容
- 戻り値:
- VersionTreeオブジェクト
 
 - 
atDocTreeFactory at(int pos) このファクトリで作成された後続のツリー・ノードに記録される位置を設定します。 位置は、ソース・ファイルまたはNOPOSの先頭からの文字オフセットでなければなりません。- パラメータ:
- pos- 位置
- 戻り値:
- このオブジェクトは、メソッドの連鎖を容易にします
 
 - 
getFirstSentenceList<DocTree> getFirstSentence(List<? extends DocTree> list) コンテンツのリストに含まれる最初の文を取得します。 最初の文の決定は実装固有のものであり、ロケール固有のBreakIteratorやその他のヒューリスティックを使用する必要があります。 結果リストは、入力リストと共通の初期アイテム・セットを共有することができます。- パラメータ:
- list- リスト
- 戻り値:
- リストの最初の文を含むリスト。
 
 
- 
 
-