Интерфейс 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)`	Создать новый объект `CodeTree`, представляющий тег `{@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)`	Создать новый объект `ExceptionTree`, представляющий тег `@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)`	Создать новый объект `LinkPlainTree`, представляющий тег `{@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.
`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` .
`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`, представляющий тег inline с неизвестным форматом.
`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)

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

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

newAuthorTree

AuthorTree newAuthorTree(List<? extends DocTree> name)

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

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

newCodeTree

LiteralTree newCodeTree(TextTree text)

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

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

newCommentTree

CommentTree newCommentTree(String text)

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

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

newDeprecatedTree

DeprecatedTree newDeprecatedTree(List<? extends DocTree> text)

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

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

newDocCommentTree

DocCommentTree newDocCommentTree(List<? extends DocTree> fullBody,
                                 List<? extends DocTree> tags)

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

Параметры:: fullBody - все содержимое комментария документации; tags - теги блоков в комментарии документации
Возвращает:: объект DocCommentTree

newDocCommentTree

DocCommentTree newDocCommentTree(List<? extends DocTree> fullBody,
                                 List<? extends DocTree> tags,
                                 List<? extends DocTree> preamble,
                                 List<? extends DocTree> postamble)

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

Параметры:: fullBody - все содержимое комментария документации; tags - теги блоков в комментарии документации; preamble - мета-содержимое html-файла, включая тег body; postamble - мета-содержимое html, включая закрывающий тег body
Возвращает:: объект DocCommentTree
С:: 10

newDocRootTree

DocRootTree newDocRootTree()

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

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

newDocTypeTree

DocTypeTree newDocTypeTree(String text)

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

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

newEndElementTree

EndElementTree newEndElementTree(Name name)

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

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

newEntityTree

EntityTree newEntityTree(Name name)

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

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

newErroneousTree

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

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

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

newExceptionTree

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

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

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

newHiddenTree

HiddenTree newHiddenTree(List<? extends DocTree> text)

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

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

newIdentifierTree

IdentifierTree newIdentifierTree(Name name)

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

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

newIndexTree

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

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

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

newInheritDocTree

InheritDocTree newInheritDocTree()

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

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

newLinkTree

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

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

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

newLinkPlainTree

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

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

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

newLiteralTree

LiteralTree newLiteralTree(TextTree text)

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

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

newParamTree

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

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

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

newProvidesTree

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

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

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

newReferenceTree

ReferenceTree newReferenceTree(String signature)

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

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

newReturnTree

ReturnTree newReturnTree(List<? extends DocTree> description)

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

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

newSeeTree

SeeTree newSeeTree(List<? extends DocTree> reference)

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

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

newSerialTree

SerialTree newSerialTree(List<? extends DocTree> description)

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

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

newSerialDataTree

SerialDataTree newSerialDataTree(List<? extends DocTree> description)

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

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

newSerialFieldTree

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

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

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

newSinceTree

SinceTree newSinceTree(List<? extends DocTree> text)

Создать новый объект, представляющий тег @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

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