Интерфейс DocTreeFactory

public interface DocTreeFactory

Фабрика для создания DocTree узлов.

Примечание о реализации:: Методы в реализации этого интерфейса могут принимать только DocTree узлы, созданные той же реализацией.
С:: 9

Краткое описание методов

Модификатор и тип	Метод	Описание
`DocTreeFactory`	`at(int pos)`	Устанавливает позицию, которая будет записываться в последующих узлах дерева, созданных этой фабрикой.
`List<DocTree>`	`getFirstSentence(List<? extends DocTree> list)`	Возвращает первое предложение, содержащееся в списке контента.
`AttributeTree`	`newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)`	Создаёт новый объект `AttributeTree`, представляющий атрибут в HTML элементе или теге.
`AuthorTree`	`newAuthorTree(List<? extends DocTree> name)`	Создаёт новый объект `AuthorTree`, представляющий тег `@author`.
`LiteralTree`	`newCodeTree(TextTree text)`	Создаёт новый объект `LiteralTree`, представляющий тег `{@code }`.
`CommentTree`	`newCommentTree(String text)`	Создаёт новый объект `CommentTree`, представляющий HTML комментарий.
`DeprecatedTree`	`newDeprecatedTree(List<? extends DocTree> text)`	Создаёт новый объект `DeprecatedTree`, представляющий тег `@deprecated`.
`DocCommentTree`	`newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)`	Создаёт новый объект `DocCommentTree`, представляющий полный комментарий к документу.
`DocCommentTree`	`newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)`	Создаёт новый объект `DocCommentTree`, представляющий весь комментарий к документу.
`DocRootTree`	`newDocRootTree()`	Создаёт новый объект `DocRootTree`, представляющий тег `{@docRoot}`.
`DocTypeTree`	`newDocTypeTree(String text)`	Создаёт новый объект `DocTypeTree`, представляющий HTML объявление `DOCTYPE`.
`EndElementTree`	`newEndElementTree(Name name)`	Создаёт новый объект `EndElement`, представляющий конец HTML элемента.
`EntityTree`	`newEntityTree(Name name)`	Создаёт новый объект `EntityTree`, представляющий HTML сущность.
`ErroneousTree`	`newErroneousTree(String text, Diagnostic<JavaFileObject> diag)`	Создаёт новый объект `ErroneousTree`, представляющий необработанный вход, который невозможно разобрать.
`EscapeTree`	`newEscapeTree(char ch)`	Создаёт новый объект `EscapeTree`, представляющий эскейпированный символ.
`ThrowsTree`	`newExceptionTree(ReferenceTree name, List<? extends DocTree> description)`	Создаёт новый объект `ThrowsTree`, представляющий тег `@exception`.
`HiddenTree`	`newHiddenTree(List<? extends DocTree> text)`	Создаёт новый объект `HiddenTree`, представляющий тег `@hidden`.
`IdentifierTree`	`newIdentifierTree(Name name)`	Создаёт новый объект `IdentifierTree`, представляющий идентификатор, например, в теге `@param`.
`IndexTree`	`newIndexTree(DocTree term, List<? extends DocTree> description)`	Создаёт новый объект `IndexTree`, представляющий тег `{@index }`.
`InheritDocTree`	`newInheritDocTree()`	Создаёт новый объект `InheritDocTree`, представляющий тег `{@inheritDoc}`.
`default InheritDocTree`	`newInheritDocTree(ReferenceTree supertype)`	Создаёт новый объект `InheritDocTree`, представляющий тег `{@inheritDoc}`.
`LinkTree`	`newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)`	Создаёт новый объект `LinkTree`, представляющий тег `{@linkplain }`.
`LinkTree`	`newLinkTree(ReferenceTree ref, List<? extends DocTree> label)`	Создаёт новый объект `LinkTree`, представляющий тег `{@link }`.
`LiteralTree`	`newLiteralTree(TextTree text)`	Создаёт новый объект `LiteralTree`, представляющий тег `{@literal }`.
`ParamTree`	`newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)`	Создаёт новый объект `ParamTree`, представляющий тег `@param`.
`ProvidesTree`	`newProvidesTree(ReferenceTree name, List<? extends DocTree> description)`	Создаёт новый объект `ProvidesTree`, представляющий тег `@provides`.
`RawTextTree`	`newRawTextTree(DocTree.Kind kind, String code)`	Создаёт новый объект `RawTextTree`, представляющий фрагмент неинтерпретированного исходного текста.
`ReferenceTree`	`newReferenceTree(String signature)`	Создаёт новый объект `ReferenceTree`, представляющий ссылку на элемент API.
`default ReturnTree`	`newReturnTree(boolean isInline, List<? extends DocTree> description)`	Создаёт новый объект `ReturnTree`, представляющий тег `@return` или тег `{@return}`.
`ReturnTree`	`newReturnTree(List<? extends DocTree> description)`	Создаёт новый объект `ReturnTree`, представляющий тег `@return`.
`SeeTree`	`newSeeTree(List<? extends DocTree> reference)`	Создаёт новый объект `SeeTree`, представляющий тег `@see`.
`SerialDataTree`	`newSerialDataTree(List<? extends DocTree> description)`	Создаёт новый объект `SerialDataTree`, представляющий тег `@serialData`.
`SerialFieldTree`	`newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)`	Создаёт новый объект `SerialFieldTree`, представляющий тег `@serialField`.
`SerialTree`	`newSerialTree(List<? extends DocTree> description)`	Создаёт новый объект `SerialTree`, представляющий тег `@serial`.
`SinceTree`	`newSinceTree(List<? extends DocTree> text)`	Создаёт новый объект `SinceTree`, представляющий тег `@since`.
`SnippetTree`	`newSnippetTree(List<? extends DocTree> attributes, TextTree text)`	Создаёт новый объект `SnippetTree`, представляющий тег `{@snippet }`.
`SpecTree`	`newSpecTree(TextTree url, List<? extends DocTree> title)`	Создаёт новый объект `SpecTree`, представляющий тег `@spec`.
`StartElementTree`	`newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)`	Создаёт новый объект `StartElementTree`, представляющий начало HTML элемента.
`default SummaryTree`	`newSummaryTree(List<? extends DocTree> summary)`	Создаёт новый объект `SummaryTree`, представляющий тег `{@summary }`.
`SystemPropertyTree`	`newSystemPropertyTree(Name propertyName)`	Создаёт новый объект `SystemPropertyTree`, представляющий тег `{@systemProperty }`.
`TextTree`	`newTextTree(String text)`	Создаёт новый объект `TextTree`, представляющий обычный текст.
`ThrowsTree`	`newThrowsTree(ReferenceTree name, List<? extends DocTree> description)`	Создаёт новый объект `ThrowsTree`, представляющий тег `@throws`.
`UnknownBlockTagTree`	`newUnknownBlockTagTree(Name name, List<? extends DocTree> content)`	Создаёт новый объект `UnknownBlockTagTree`, представляющий нераспознанный блочный тег.
`UnknownInlineTagTree`	`newUnknownInlineTagTree(Name name, List<? extends DocTree> content)`	Создаёт новый объект `UnknownInlineTagTree`, представляющий нераспознанный инлайновый тег.
`UsesTree`	`newUsesTree(ReferenceTree name, List<? extends DocTree> description)`	Создаёт новый объект `UsesTree`, представляющий тег `@uses`.
`ValueTree`	`newValueTree(ReferenceTree ref)`	Создаёт новый объект `ValueTree`, представляющий тег `{@value }`.
`default ValueTree`	`newValueTree(TextTree format, ReferenceTree ref)`	Создаёт новый объект `ValueTree`, представляющий тег `{@value }`.
`VersionTree`	`newVersionTree(List<? extends DocTree> text)`	Создаёт новый объект `VersionTree`, представляющий тег `{@version }`.

Подробное описание методов

newAttributeTree

AttributeTree newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)

Создаёт новый AttributeTree объект, представляющий атрибут в HTML-элементе или теге.

Параметры:: name - имя атрибута; vkind - тип значения атрибута; value - значение атрибута, если оно есть
Возвращает:: объект AttributeTree

newAuthorTree

AuthorTree newAuthorTree(List<? extends DocTree> name)

Создаёт новый AuthorTree объект, представляющий тег @author.

Параметры:: name - имя автора
Возвращает:: объект AuthorTree

newCodeTree

LiteralTree newCodeTree(TextTree text)

Создаёт новый LiteralTree объект, представляющий тег {@code }.

Параметры:: text - содержимое тега
Возвращает:: объект LiteralTree

newCommentTree

CommentTree newCommentTree(String text)

Создаёт новый CommentTree, представляющий HTML-комментарий.

Параметры:: text - содержимое комментария
Возвращает:: объект CommentTree

newDeprecatedTree

DeprecatedTree newDeprecatedTree(List<? extends DocTree> text)

Создаёт новый DeprecatedTree объект, представляющий тег @deprecated.

Параметры:: 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 - метаданные HTML-файла, включая тег body; postamble - метаданные HTML-файла, включая закрывающий тег body
Возвращает:: объект DocCommentTree
С:: 10

newDocRootTree

DocRootTree newDocRootTree()

Создаёт новый DocRootTree объект, представляющий тег {@docRoot}.

Возвращает:: объект DocRootTree

newDocTypeTree

DocTypeTree newDocTypeTree(String text)

Создаёт новый DocTypeTree, представляющий объявление DOCTYPE HTML.

Параметры:: text - содержимое объявления
Возвращает:: объект DocTypeTree
С:: 10

newEndElementTree

EndElementTree newEndElementTree(Name name)

Создаёт новый EndElement объект, представляющий конец HTML-элемента.

Параметры:: name - имя HTML-элемента
Возвращает:: объект EndElementTree

newEntityTree

EntityTree newEntityTree(Name name)

Создаёт новый EntityTree объект, представляющий HTML-сущность.

Параметры:: name - имя сущности, представляющей символы между '&' и ';' в представлении сущности в HTML-документе
Возвращает:: объект EntityTree

newErroneousTree

ErroneousTree newErroneousTree(String text, Diagnostic<JavaFileObject> diag)

Создаёт новый ErroneousTree объект, представляющий неразборчивый ввод.

Параметры:: text - неразборчивый текст; diag - диагностика, связанная с неразборчивым текстом, или null
Возвращает:: объект ErroneousTree

newEscapeTree

EscapeTree newEscapeTree(char ch)

Создаёт новый EscapeTree объект, представляющий экранированный символ.

Примечание API:

Этот метод сам по себе не ограничивает набор допустимых последовательностей экранирования, хотя набор может быть фактически ограничен теми, которые определены в Спецификации комментариев к документации для стандартного модуля Doclet, включая следующие контекстно-зависимые последовательности экранирования:

@@, представляющее @, где в противном случае оно рассматривалось бы как введение блока или встроенного тега,
@/, представляющее /, как часть *@/ для представления &ast;/, и
@*, представляющее *, где в противном случае оно было бы проигнорировано, после пробелов в начале строки.

Параметры:

ch - символ

Возвращает:

объект EscapeTree

С:

newExceptionTree

ThrowsTree newExceptionTree(ReferenceTree name, List<? extends DocTree> description)

Создаёт новый ThrowsTree объект, представляющий тег @exception.

Параметры:: name - имя исключения; description - описание причины возникновения исключения
Возвращает:: объект ThrowsTree

newHiddenTree

HiddenTree newHiddenTree(List<? extends DocTree> text)

Создаёт новый HiddenTree объект, представляющий тег @hidden.

Параметры:: text - содержимое тега
Возвращает:: объект HiddenTree

newIdentifierTree

IdentifierTree newIdentifierTree(Name name)

Создаёт новый IdentifierTree объект, представляющий идентификатор, например, в теге @param.

Параметры:: name - имя идентификатора
Возвращает:: объект IdentifierTree

newIndexTree

IndexTree newIndexTree(DocTree term, List<? extends DocTree> description)

Создаёт новый IndexTree объект, представляющий тег {@index }.

Параметры:: term - поисковой запрос; description - необязательное описание поискового запроса
Возвращает:: объект IndexTree

newInheritDocTree

InheritDocTree newInheritDocTree()

Создаёт новый InheritDocTree объект, представляющий тег {@inheritDoc}.

Возвращает:: объект InheritDocTree

newInheritDocTree

default InheritDocTree newInheritDocTree(ReferenceTree supertype)

Создаёт новый InheritDocTree объект, представляющий тег {@inheritDoc}.

Требования к реализации:: Эта реализация выбрасывает UnsupportedOperationException.
Параметры:: supertype - ссылка на суперкласс или суперинтерфейс
Возвращает:: объект InheritDocTree
С:: 22

newLinkTree

LinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label)

Создаёт новый LinkTree объект, представляющий тег {@link }.

Параметры:: ref - ссылаемый элемент API; label - необязательная метка для ссылки
Возвращает:: объект LinkTree

newLinkPlainTree

LinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)

Создаёт новый объект LinkTree, для представления тега {@linkplain }.

Параметры:: ref - элемент API, на который указывает ссылка; label - необязательная метка для ссылки
Возвращает:: объект LinkTree

newLiteralTree

LiteralTree newLiteralTree(TextTree text)

Создаёт новый объект LiteralTree, для представления тега {@literal }.

Параметры:: text - содержимое тега
Возвращает:: объект LiteralTree

newParamTree

ParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)

Создаёт новый объект ParamTree, для представления тега @param.

Параметры:: isTypeParameter - true, если это параметр типа, и false в противном случае; name - описываемый параметр; description - описание параметра
Возвращает:: объект ParamTree

newProvidesTree

ProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description)

Создаёт новый объект ProvidesTree, для представления тега @provides.

Параметры:: name - имя типа сервиса; description - описание предоставляемого сервиса
Возвращает:: объект ProvidesTree

newRawTextTree

RawTextTree newRawTextTree(DocTree.Kind kind, String code)

Создаёт новый объект RawTextTree, для представления фрагмента неинтерпретированного исходного текста.

Параметры:: kind - тип текста; code - код
Возвращает:: объект RawTextTree
Исключение:: IllegalArgumentException - если тип не является распознанным типом для исходного текста
С:: 23

newReferenceTree

ReferenceTree newReferenceTree(String signature)

Создаёт новый объект ReferenceTree, для представления ссылки на элемент API.

Параметры:: signature - подпись документации ссылки
Возвращает:: объект ReferenceTree

newReturnTree

ReturnTree newReturnTree(List<? extends DocTree> description)

Создаёт новый объект ReturnTree, для представления тега @return.

Параметры:: description - описание возвращаемого значения метода
Возвращает:: объект ReturnTree

newReturnTree

default ReturnTree newReturnTree(boolean isInline, List<? extends DocTree> description)

Создаёт новый объект ReturnTree, для представления тега @return или тега {@return}.

Требования к реализации:: Эта реализация выбрасывает UnsupportedOperationException, если UnsupportedOperationException равен true, и вызывает newReturnTree(List) в противном случае.
Параметры:: isInline - true, если этот экземпляр как встроенный тег, и false в противном случае; description - описание возвращаемого значения метода
Возвращает:: объект ReturnTree
Исключение:: UnsupportedOperationException - если встроенные теги {@return} не поддерживаются
С:: 16

newSeeTree

SeeTree newSeeTree(List<? extends DocTree> reference)

Создаёт новый объект SeeTree, для представления тега @see.

Параметры:: reference - ссылка
Возвращает:: объект SeeTree

newSerialTree

SerialTree newSerialTree(List<? extends DocTree> description)

Создаёт новый объект SerialTree, для представления тега @serial.

Параметры:: description - описание тега
Возвращает:: объект SerialTree

newSerialDataTree

SerialDataTree newSerialDataTree(List<? extends DocTree> description)

Создаёт новый объект SerialDataTree, для представления тега @serialData.

Параметры:: description - описание тега
Возвращает:: объект SerialDataTree

newSerialFieldTree

SerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)

Создаёт новый объект SerialFieldTree, для представления тега @serialField.

Параметры:: name - имя поля; type - тип поля; description - описание поля
Возвращает:: объект SerialFieldTree

newSinceTree

SinceTree newSinceTree(List<? extends DocTree> text)

Создаёт новый объект SinceTree, для представления тега @since.

Параметры:: text - содержимое тега
Возвращает:: объект SinceTree

newSnippetTree

SnippetTree newSnippetTree(List<? extends DocTree> attributes, TextTree text)

Создаёт новый объект SnippetTree, для представления тега {@snippet }.

Параметры:: attributes - атрибуты тега; text - тело тега, или null, если тег не имеет тела (не путать с пустым телом)
Возвращает:: объект SnippetTree
С:: 18

newSpecTree

SpecTree newSpecTree(TextTree url, List<? extends DocTree> title)

Создаёт новый объект SpecTree, для представления тега @spec.

Параметры:: url - url; title - заголовок
Возвращает:: объект SpecTree
С:: 20

newStartElementTree

StartElementTree newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)

Создаёт новый объект StartElementTree, для представления начала HTML элемента.

Параметры:: name - имя HTML элемента; attrs - атрибуты; selfClosing - true, если стартовый элемент помечен как самозакрывающийся; иначе false
Возвращает:: объект StartElementTree

newSummaryTree

default SummaryTree newSummaryTree(List<? extends DocTree> summary)

Создаёт новый объект SummaryTree, для представления тега {@summary }.

Требования к реализации:: Эта реализация выбрасывает UnsupportedOperationException.
Параметры:: summary - содержимое тега
Возвращает:: объект SummaryTree
С:: 10

newSystemPropertyTree

SystemPropertyTree newSystemPropertyTree(Name propertyName)

Создаёт новый объект SystemPropertyTree, для представления тега {@systemProperty }.

Параметры:: propertyName - имя системной переменной
Возвращает:: объект SystemPropertyTree
С:: 12

newTextTree

TextTree newTextTree(String text)

Создаёт новый объект TextTree, для представления простого текста.

Параметры:: text - текст
Возвращает:: объект TextTree

newThrowsTree

ThrowsTree newThrowsTree(ReferenceTree name, List<? extends DocTree> description)

Создаёт новый объект ThrowsTree, для представления тега @throws.

Параметры:: 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)

Создаёт новый объект UsesTree для представления тега @uses.

Параметры:: name - имя типа сервиса; description - описание того, как будет использоваться сервис
Возвращает:: объект UsesTree

newValueTree

ValueTree newValueTree(ReferenceTree ref)

Создаёт новый объект ValueTree для представления тега {@value }.

Параметры:: ref - ссылка на значение
Возвращает:: объект ValueTree

newValueTree

default ValueTree newValueTree(TextTree format, ReferenceTree ref)

Создаёт новый объект ValueTree для представления тега {@value }.

Требования к реализации:: В этой реализации вызывается newValueTree(ref).
Параметры:: format - строка формата для значения; ref - ссылка на значение
Возвращает:: объект ValueTree
С момента:: 20

newVersionTree

VersionTree newVersionTree(List<? extends DocTree> text)

Создаёт новый объект VersionTree для представления тега {@version }.

Параметры:: text - содержимое тега
Возвращает:: объект VersionTree

at

DocTreeFactory at(int pos)

Устанавливает позицию, которая будет записываться в последующих узлах дерева, созданных этим фабричным методом. Позиция должна быть смещением символов относительно начала исходного файла или NOPOS.

Параметры:: pos - позиция
Возвращает:: этот объект, для удобства цепочки вызовов методов

getFirstSentence

List<DocTree> getFirstSentence(List<? extends DocTree> list)

Получает первое предложение, содержащееся в списке содержимого. Определение первого предложения зависит от реализации и может включать использование специфичного для языка разбиения текста BreakIterator и других эвристик. Результирующий список может иметь общие начальные элементы со входным списком.

Параметры:: list - список
Возвращает:: список, содержащий первое предложение из списка

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/jdk.compiler/com/sun/source/util/DocTreeFactory.html