Интерфейс 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 в теге 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`, представляющий необработанный ввод.
`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`.
`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 }`.
`VersionTree`	`newVersionTree(List<? extends DocTree> text)`	Создаёт новый объект `VersionTree`, представляющий тег `{@version }`.

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

newAttributeTree

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

Создаёт новый объект AttributeTree, для представления атрибута HTML в теге 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
C момента:: 10

newDocRootTree

DocRootTree newDocRootTree()

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

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

newDocTypeTree

DocTypeTree newDocTypeTree(String text)

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

Параметры:: text - содержимое объявления
Возвращает:: объект DocTypeTree
C момента:: 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

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.

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

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, если isInline имеет значение 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

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

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, 2021, 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/17/docs/api/jdk.compiler/com/sun/source/util/DocTreeFactory.html