Класс DocTrees

java.lang.Object

com.sun.source.util.Trees

com.sun.source.util.DocTrees

public abstract class DocTrees extends Trees

Обеспечивает доступ к синтаксическим деревьям для комментариев к документации.

С момента:: 1.8

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

Конструктор	Описание
`DocTrees()`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`abstract BreakIterator`	`getBreakIterator()`	Возвращает итератор разбиения, используемый для вычисления первой фразы комментариев к документации.
`abstract String`	`getCharacters(EntityTree tree)`	Возвращает строку, содержащую символы для сущности в данном дереве сущностей, или `null` если дерево не представляет собой допустимый ряд символов.
`abstract DocCommentTree`	`getDocCommentTree(TreePath path)`	Возвращает дерево комментария к документации, если оно есть, для узла Tree, идентифицируемого заданным TreePath.
`abstract DocCommentTree`	`getDocCommentTree(Element e)`	Возвращает дерево комментария к документации данного элемента.
`abstract DocCommentTree`	`getDocCommentTree(Element e, String relativePath)`	Возвращает дерево комментария к документации данного файла, путь которого указан относительно данного элемента.
`abstract DocCommentTree`	`getDocCommentTree(FileObject fileObject)`	Возвращает дерево комментария к документации данного файла.
`abstract DocTreeFactory`	`getDocTreeFactory()`	Возвращает служебный объект для создания `DocTree` объектов.
`abstract DocTreePath`	`getDocTreePath(FileObject fileObject, PackageElement packageElement)`	Возвращает путь к дереву документации, содержащий дерево комментария к документации данного файла.
`abstract Element`	`getElement(DocTreePath path)`	Возвращает элемент модели языка, на который ссылается лист узла данного `DocTreePath`, или `null` если неизвестно.
`abstract List<DocTree>`	`getFirstSentence(List<? extends DocTree> list)`	Возвращает список `DocTree`, представляющих первую фразу комментария.
`abstract DocSourcePositions`	`getSourcePositions()`	Возвращает служебный объект для доступа к позициям исходного кода узлов дерева документации.
`abstract TypeMirror`	`getType(DocTreePath path)`	Возвращает тип модели языка, на который ссылается лист узла данного `DocTreePath`, или `null` если неизвестно.
`static DocTrees`	`instance(ProcessingEnvironment env)`	Возвращает объект DocTrees для данного ProcessingEnvironment.
`static DocTrees`	`instance(JavaCompiler.CompilationTask task)`	Возвращает объект DocTrees для данной CompilationTask.
`abstract void`	`printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)`	Выводит сообщение указанного типа в месте узла в предоставленной единице компиляции
`abstract void`	`setBreakIterator(BreakIterator breakIterator)`	Устанавливает итератор разбиения для вычисления первой фразы комментариев к документации.

Методы, объявленные в классе com.sun.source.util.Trees

getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

DocTrees

public DocTrees()

Конструктор для вызова подклассами.

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

instance

public static DocTrees instance(JavaCompiler.CompilationTask task)

Возвращает объект DocTrees для заданной CompilationTask.

Параметры:: task - задача компиляции, для которой требуется получить объект Trees
Возвращает:: объект DocTrees
Исключение:: IllegalArgumentException - если задача не поддерживает API Trees.

instance

public static DocTrees instance(ProcessingEnvironment env)

Возвращает объект DocTrees для заданной ProcessingEnvironment.

Параметры:: env - среда обработки, для которой требуется получить объект Trees
Возвращает:: объект DocTrees
Исключение:: IllegalArgumentException - если среда не поддерживает API Trees.

getBreakIterator

public abstract BreakIterator getBreakIterator()

Возвращает разделитель итераций, используемый для вычисления первого предложения в комментариях к документации. Возвращает null если он не задан.

Возвращает:: разделитель итераций
С момента:: 9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(TreePath path)

Возвращает дерево комментариев к документации, если таковое имеется, для узла дерева, идентифицируемого заданным TreePath. Возвращает null если комментарий к документации не найден.

Параметры:: path - путь к узлу дерева
Возвращает:: дерево комментариев к документации

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(Element e)

Возвращает дерево комментариев к документации заданного элемента. Возвращает null если комментарий к документации не найден.

Параметры:: e - элемент, для которого требуется документация
Возвращает:: дерево комментариев к документации
С момента:: 9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(FileObject fileObject)

Возвращает дерево комментариев к документации заданного файла. Файл должен быть файлом HTML, в этом случае дерево комментариев к документации представляет собой все содержимое файла. Возвращает null если комментарий к документации не найден. В будущих версиях могут быть добавлены поддержка дополнительных типов файлов.

Параметры:: fileObject - контейнер содержимого
Возвращает:: дерево комментариев к документации
С момента:: 9

getDocCommentTree

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

Возвращает дерево комментариев к документации заданного файла, путь к которому задан относительно заданного элемента. Файл должен быть файлом HTML, в этом случае дерево комментариев к документации представляет собой содержимое тега <body>, а любые вложенные теги игнорируются. Возвращает null если комментарий к документации не найден. В будущих версиях могут быть добавлены поддержка дополнительных типов файлов.

Параметры:: e - элемент, используемый в качестве ссылки для определения пути; relativePath - относительный путь от элемента
Возвращает:: дерево комментариев к документации
Исключение:: IOException - если произошла ошибка
С момента:: 9

getDocTreePath

public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)

Возвращает путь к дереву документации, содержащий дерево комментариев к документации заданного файла. Файл должен быть файлом HTML, в этом случае дерево комментариев к документации представляет собой содержимое тега <body>, а любые вложенные теги игнорируются. Любые ссылки на элементы исходного кода, содержащиеся в тегах @see и {@link} в дереве комментариев к документации, будут оцениваться в контексте заданного элемента пакета. Возвращает null если комментарий к документации не найден.

Параметры:: fileObject - объект файла, содержащий HTML-содержимое; packageElement - элемент пакета, который нужно ассоциировать с данным объектом файла, представляющим устаревший пакет.html, иначе null
Возвращает:: путь к дереву документации, содержащий дерево комментариев к документации, разобранное из заданного файла
Исключение:: IllegalArgumentException - если файл не является файлом HTML
С момента:: 9

getElement

public abstract Element getElement(DocTreePath path)

Возвращает элемент модели языка, на который ссылается лист узла данного DocTreePath, или null если неизвестно.

Параметры:: path - путь к узлу дерева
Возвращает:: элемент

getType

public abstract TypeMirror getType(DocTreePath path)

Возвращает тип модели языка, на который ссылается лист узла данного DocTreePath, или null если неизвестно. Этот метод обычно возвращает то же значение, что и getElement(path).asType() для аргумента path, для которого getElement(DocTreePath) возвращает ненулевое значение, но может возвращать тип, содержащий дополнительную информацию, например, параметризованный обобщённый тип вместо простого типа.

Параметры:: path - путь к узлу дерева
Возвращает:: ссылочный тип или null
С момента:: 15

getFirstSentence

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

Возвращает список DocTree, представляющих первое предложение комментария.

Параметры:: list - список DocTree для проверки
Возвращает:: первое предложение
С момента:: 9

getSourcePositions

public abstract DocSourcePositions getSourcePositions()

Возвращает утилиту для доступа к позициям исходного кода узлов дерева документации.

Определено в:: getSourcePositions в классе Trees
Возвращает:: утилиту

printMessage

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

Выводит сообщение указанного типа в позиции дерева в предоставленной единице компиляции

Параметры:: kind - тип сообщения; msg - сообщение или пустая строка, если отсутствует; t - дерево, используемое в качестве подсказки позиции; c - дерево комментария к документации, используемое в качестве подсказки позиции; root - единица компиляции, содержащая дерево

setBreakIterator

public abstract void setBreakIterator(BreakIterator breakIterator)

Устанавливает разделитель итераций для вычисления первого предложения в комментариях к документации.

Параметры:: breakIterator - разделитель итераций или null для указания стандартного разделителя предложений
С момента:: 9

getDocTreeFactory

public abstract DocTreeFactory getDocTreeFactory()

Возвращает утилиту для создания объектов DocTree.

Возвращает:: утилиту для создания объектов DocTree
С момента:: 9

getCharacters

public abstract String getCharacters(EntityTree tree)

Возвращает строку, содержащую символы для сущности в заданном дереве сущностей, или null если дерево не представляет собой допустимого набора символов.

Интерпретация сущностей основана на разделе 8.1.4. Ссылок на символы в спецификации HTML 5.2.

Параметры:: tree - дерево, содержащее сущность
Возвращает:: строка, содержащая символы

© 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/DocTrees.html