Класс DocTrees

public DocTrees()

public static DocTrees instance(JavaCompiler.CompilationTask task)

Параметры:

task — задача компиляции, для которой требуется получить объект Trees

Возвращает:

объект DocTrees

Вызывает исключение:

IllegalArgumentException — если задача не поддерживает API Trees.

public static DocTrees instance(ProcessingEnvironment env)

Параметры:

env — среда обработки, для которой требуется получить объект Trees

Возвращает:

объект DocTrees

Вызывает исключение:

IllegalArgumentException — если среда не поддерживает API Trees.

public abstract BreakIterator getBreakIterator()

Возвращает:

итератор разбиения

С момента:

9

public abstract Elements.DocCommentKind getDocCommentKind(TreePath path)

Параметры:

path — путь к узлу дерева

Возвращает:

стиль комментария документации, связанного с узлом дерева

С момента:

23

См. также:

• Trees.getPath(Element)

public abstract DocCommentTree getDocCommentTree(TreePath path)

Примечание по реализации:

Реализация этого метода по умолчанию возвращает один и тот же экземпляр DocCommentTree при повторных вызовах с одинаковым аргументом.

Параметры:

path — путь к узлу дерева

Возвращает:

дерево комментария документации

public abstract DocCommentTree getDocCommentTree(Element e)

Примечание по реализации:

Реализация этого метода по умолчанию возвращает один и тот же экземпляр DocCommentTree при повторных вызовах с одинаковым аргументом.

Параметры:

e — элемент, документация которого требуется

Возвращает:

дерево комментария документации

С момента:

9

public abstract DocCommentTree getDocCommentTree(FileObject fileObject)

Примечание по реализации:

Реализация этого метода по умолчанию возвращает новый экземпляр DocCommentTree при каждом вызове.

Параметры:

fileObject — контейнер содержимого

Возвращает:

дерево комментария документации

Вызывает исключение:

IllegalArgumentException — если тип файла не поддерживается

С момента:

9

public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException

Примечание по реализации:

Реализация этого метода по умолчанию возвращает новый экземпляр DocCommentTree при каждом вызове.

Параметры:

e — элемент, путь к которому используется в качестве ссылки

relativePath — относительный путь от Element

Возвращает:

дерево комментария документации

Вызывает исключение:

IOException — если возникает исключение

IllegalArgumentException — если тип файла не поддерживается

С момента:

9

public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)

Параметры:

fileObject — объект файла, содержащий содержимое HTML

packageElement — элемент пакета, связываемый с заданным объектом файла, представляющим устаревший package.html; в противном случае — null

Возвращает:

путь дерева документации, содержащий комментарий документации, разобранный из заданного файла

Вызывает исключение:

IllegalArgumentException — если тип файла не поддерживается

С момента:

9

public abstract Element getElement(DocTreePath path)

Параметры:

path — путь к узлу дерева

Возвращает:

элемент, на который имеется ссылка, или null

См. также:

• getType(DocTreePath)

public abstract TypeMirror getType(DocTreePath path)

Параметры:

path — путь к узлу дерева

Возвращает:

тип, на который имеется ссылка, или null

С момента:

15

См. также:

• getElement(DocTreePath)

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

Параметры:

list — список DocTree для обработки

Возвращает:

первое предложение

С момента:

9

public abstract DocSourcePositions getSourcePositions()

Переопределяет:

getSourcePositions в классе Trees

Возвращает:

вспомогательный объект

public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)

Параметры:

kind — тип сообщения

msg — сообщение или пустая строка, если сообщения нет

t — дерево, используемое в качестве подсказки для определения позиции

c — дерево комментария документации, используемое в качестве подсказки для определения позиции

root — единица компиляции, содержащая дерево

public abstract void setBreakIterator(BreakIterator breakIterator)

Параметры:

breakIterator — итератор разбиения или null для использования стандартного разделителя предложений

С момента:

9

public abstract DocTreeFactory getDocTreeFactory()

Возвращает:

вспомогательный объект для создания объектов DocTree

С момента:

9

public abstract String getCharacters(EntityTree tree)

Параметры:

tree — дерево, содержащее сущность

Возвращает:

строка, содержащая символы

С момента:

16

Внешние спецификации

• Стандарт HTML