Интерфейс DocTreeFactory

public interface DocTreeFactory

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

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

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

Modifier and Type	Method	Description
`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`, представляющий `DOCTYPE` HTML-декларацию.
`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}`.
`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`.
`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

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.

Parameters:: name - имя типа сервиса; description - описание предоставляемого сервиса
Returns:: объект ProvidesTree

newReferenceTree

ReferenceTree newReferenceTree(String signature)

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

Parameters:: signature - подпись документации к ссылке
Returns:: объект ReferenceTree

newReturnTree

ReturnTree newReturnTree(List<? extends DocTree> description)

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

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

newReturnTree

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

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

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

newSeeTree

SeeTree newSeeTree(List<? extends DocTree> reference)

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

Parameters:: reference - ссылка
Returns:: объект SeeTree

newSerialTree

SerialTree newSerialTree(List<? extends DocTree> description)

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

Parameters:: description - описание для тэга
Returns:: объект SerialTree

newSerialDataTree

SerialDataTree newSerialDataTree(List<? extends DocTree> description)

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

Parameters:: description - описание для тэга
Returns:: объект SerialDataTree

newSerialFieldTree

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

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

Parameters:: name - имя поля; type - тип поля; description - описание поля
Returns:: объект SerialFieldTree

newSinceTree

SinceTree newSinceTree(List<? extends DocTree> text)

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

Parameters:: text - содержимое тэга
Returns:: объект SinceTree

newSnippetTree

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

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

Parameters:: attributes - атрибуты тэга; text - тело тэга, или null если тэг не имеет тела (не путать с пустым телом)
Returns:: объект SnippetTree
Since:: 18

newSpecTree

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

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

Parameters:: url - URL; title - заголовок
Returns:: объект SpecTree
Since:: 20

newStartElementTree

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

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

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

newSummaryTree

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

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

Implementation Requirements:: Эта реализация выбрасывает UnsupportedOperationException.
Parameters:: summary - содержимое тэга
Returns:: объект SummaryTree
Since:: 10

newSystemPropertyTree

SystemPropertyTree newSystemPropertyTree(Name propertyName)

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

Parameters:: propertyName - имя системной переменной
Returns:: объект SystemPropertyTree
Since:: 12

newTextTree

TextTree newTextTree(String text)

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

Parameters:: text - текст
Returns:: объект TextTree

newThrowsTree

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

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

Parameters:: name - имя исключения; description - описание причины возможного возникновения исключения
Returns:: объект ThrowsTree

newUnknownBlockTagTree

UnknownBlockTagTree newUnknownBlockTagTree(Name name, List<? extends DocTree> content)

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

Parameters:: name - имя блочного тэга; content - содержимое
Returns:: объект UnknownBlockTagTree

newUnknownInlineTagTree

UnknownInlineTagTree newUnknownInlineTagTree(Name name, List<? extends DocTree> content)

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

Parameters:: name - имя инлайнового тэга; content - содержимое
Returns:: объект UnknownInlineTagTree

newUsesTree

UsesTree newUsesTree(ReferenceTree name, List<? extends DocTree> description)

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

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

newValueTree

ValueTree newValueTree(ReferenceTree ref)

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

Parameters:: ref - ссылка на значение
Returns:: объект ValueTree

newValueTree

default ValueTree newValueTree(TextTree format, ReferenceTree ref)

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

Implementation Requirements:: Эта реализация вызывает newValueTree(ref).
Parameters:: format - строка формата для значения; ref - ссылка на значение
Returns:: объект ValueTree
Since:: 20

newVersionTree

VersionTree newVersionTree(List<? extends DocTree> text)

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

Parameters:: text - содержимое тэга
Returns:: объект VersionTree

at

DocTreeFactory at(int pos)

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

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

getFirstSentence

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

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

Parameters:: list - список
Returns:: список, содержащий первое предложение из списка

© 1993, 2023, 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://docs.oracle.com/en/java/javase/21/docs/api/jdk.compiler/com/sun/source/util/DocTreeFactory.html