Интерфейс DocTreeFactory

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

Параметры:

name — имя атрибута

vkind — вид значения атрибута

value — значение атрибута, если оно есть

Возвращает:

объект AttributeTree

AuthorTree newAuthorTree(List<? extends DocTree> name)

Параметры:

name — имя автора

Возвращает:

объект AuthorTree

LiteralTree newCodeTree(TextTree text)

Параметры:

text — содержимое тега

Возвращает:

объект LiteralTree

CommentTree newCommentTree(String text)

Параметры:

text — содержимое комментария

Возвращает:

объект CommentTree

DeprecatedTree newDeprecatedTree(List<? extends DocTree> text)

Параметры:

text — содержимое тега

Возвращает:

объект DeprecatedTree

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

Параметры:

fullBody — все тело комментария документации

tags — блочные теги в комментарии документации

Возвращает:

объект DocCommentTree

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

DocRootTree newDocRootTree()

Возвращает:

объект DocRootTree

DocTypeTree newDocTypeTree(String text)

Параметры:

text — содержимое объявления

Возвращает:

объект DocTypeTree

Начиная с:

10

EndElementTree newEndElementTree(Name name)

Параметры:

name — имя элемента HTML

Возвращает:

объект EndElementTree

EntityTree newEntityTree(Name name)

Параметры:

name — имя сущности, обозначающее символы между «&» и «;» в представлении сущности в документе HTML

Возвращает:

объект EntityTree

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

Параметры:

text — неразбираемый текст

diag — диагностика, связанная с неразбираемым текстом, или null

Возвращает:

объект ErroneousTree

EscapeTree newEscapeTree(char ch)

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

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

• @@, представляет @, где в противном случае он трактовался бы как начало блочного или встроенного тега,
• @/, представляет / в составе *@/ для представления */, и
• @*, представляет * там, где в противном случае он был бы отброшен после пробельных символов в начале строки.

Параметры:

ch — символ

Возвращает:

объект EscapeTree

Начиная с:

21

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

Параметры:

name — имя исключения

description — описание причины, по которой может быть выброшено исключение

Возвращает:

объект ThrowsTree

HiddenTree newHiddenTree(List<? extends DocTree> text)

Параметры:

text — содержимое тега

Возвращает:

объект HiddenTree

IdentifierTree newIdentifierTree(Name name)

Параметры:

name — имя идентификатора

Возвращает:

объект IdentifierTree

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

Параметры:

term — поисковый запрос

description — необязательное описание поискового запроса

Возвращает:

объект IndexTree

InheritDocTree newInheritDocTree()

Возвращает:

объект InheritDocTree

default InheritDocTree newInheritDocTree(ReferenceTree supertype)

Требования к реализации:

Эта реализация выбрасывает UnsupportedOperationException.

Параметры:

supertype — ссылка на суперкласс или суперинтерфейс

Возвращает:

объект InheritDocTree

Начиная с:

22

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

Параметры:

ref — элемент API, на который ссылаются

label — необязательная метка ссылки

Возвращает:

объект LinkTree

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

Параметры:

ref — элемент API, на который ссылаются

label — необязательная метка ссылки

Возвращает:

объект LinkTree

LiteralTree newLiteralTree(TextTree text)

Параметры:

text — содержимое тега

Возвращает:

объект LiteralTree

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

Параметры:

isTypeParameter — true, если это параметр типа, и false в противном случае

name — описываемый параметр

description — описание параметра

Возвращает:

объект ParamTree

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

Параметры:

name — имя типа службы

description — описание предоставляемой службы

Возвращает:

объект ProvidesTree

RawTextTree newRawTextTree(DocTree.Kind kind, String code)

Параметры:

kind — вид текста

code — код

Возвращает:

объект RawTextTree

Выбрасывает:

IllegalArgumentException — если вид не распознан как вид необработанного текста

Начиная с:

23

ReferenceTree newReferenceTree(String signature)

Параметры:

signature — сигнатура ссылки в комментарии документации

Возвращает:

объект ReferenceTree

ReturnTree newReturnTree(List<? extends DocTree> description)

Параметры:

description — описание возвращаемого методом значения

Возвращает:

объект ReturnTree

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

Требования к реализации:

Эта реализация выбрасывает UnsupportedOperationException, если isInline равно true, а в противном случае вызывает newReturnTree(List).

Параметры:

isInline — true, если этот экземпляр используется как встроенный тег, и false в противном случае

description — описание возвращаемого методом значения

Возвращает:

объект ReturnTree

Выбрасывает:

UnsupportedOperationException — если встроенные теги {@return} не поддерживаются

Начиная с:

16

SeeTree newSeeTree(List<? extends DocTree> reference)

Параметры:

reference — ссылка

Возвращает:

объект SeeTree

SerialTree newSerialTree(List<? extends DocTree> description)

Параметры:

description — описание тега

Возвращает:

объект SerialTree

SerialDataTree newSerialDataTree(List<? extends DocTree> description)

Параметры:

description — описание тега

Возвращает:

объект SerialDataTree

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

Параметры:

name — имя поля

type — тип поля

description — описание поля

Возвращает:

объект SerialFieldTree

SinceTree newSinceTree(List<? extends DocTree> text)

Параметры:

text — содержимое тега

Возвращает:

объект SinceTree

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

Параметры:

attributes — атрибуты тега

text — тело тега или null, если у тега нет тела (не следует путать с пустым телом)

Возвращает:

объект SnippetTree

Начиная с:

18

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

Параметры:

url — URL

title — заголовок

Возвращает:

объект SpecTree

Начиная с:

20

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

Параметры:

name — имя элемента HTML

attrs — атрибуты

selfClosing — true, если начальный элемент помечен как самозакрывающийся; в противном случае false

Возвращает:

объект StartElementTree

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

Требования к реализации:

Эта реализация выбрасывает UnsupportedOperationException.

Параметры:

summary — содержимое тега

Возвращает:

объект SummaryTree

Начиная с:

10

SystemPropertyTree newSystemPropertyTree(Name propertyName)

Параметры:

propertyName — имя системного свойства

Возвращает:

объект SystemPropertyTree

Начиная с:

12

TextTree newTextTree(String text)

Параметры:

text — текст

Возвращает:

объект TextTree

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

Параметры:

name — имя исключения

description — описание причины, по которой может быть выброшено исключение

Возвращает:

объект ThrowsTree

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

Параметры:

name — имя блочного тега

content — содержимое

Возвращает:

объект UnknownBlockTagTree

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

Параметры:

name — имя встроенного тега

content — содержимое

Возвращает:

объект UnknownInlineTagTree

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

Параметры:

name — имя типа службы

description — описание использования службы

Возвращает:

объект UsesTree

ValueTree newValueTree(ReferenceTree ref)

Параметры:

ref — ссылка на значение

Возвращает:

объект ValueTree

default ValueTree newValueTree(TextTree format, ReferenceTree ref)

Требования к реализации:

Эта реализация вызывает newValueTree(ref).

Параметры:

format — строка формата для значения

ref — ссылка на значение

Возвращает:

объект ValueTree

Начиная с:

20

VersionTree newVersionTree(List<? extends DocTree> text)

Параметры:

text — содержимое тега

Возвращает:

объект VersionTree

DocTreeFactory at(int pos)

Параметры:

pos — позиция

Возвращает:

этот объект для обеспечения цепочки вызовов методов

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

Параметры:

list — список

Возвращает:

список, содержащий первое предложение из списка