Класс DocTrees

public abstract class DocTrees
extends Trees

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

Since:
1.8

Конструкторы

КонструкторОписание
DocTrees()

Методы

Модификатор и типМетодОписание
abstract BreakIteratorgetBreakIterator()

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

abstract DocCommentTreegetDocCommentTree​(TreePath path)

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

abstract DocCommentTreegetDocCommentTree​(Element e)

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

abstract DocCommentTreegetDocCommentTree​(Element e, String relativePath)

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

abstract DocCommentTreegetDocCommentTree​(FileObject fileObject)

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

abstract DocTreeFactorygetDocTreeFactory()

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

abstract DocTreePathgetDocTreePath​(FileObject fileObject, PackageElement packageElement)

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

abstract ElementgetElement​(DocTreePath path)

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

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

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

abstract DocSourcePositionsgetSourcePositions()

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

static DocTreesinstance​(ProcessingEnvironment env)

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

static DocTreesinstance​(JavaCompiler.CompilationTask task)

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

abstract voidprintMessage​(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)

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

abstract voidsetBreakIterator​(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.

Parameters:
task - задача компиляции, для которой требуется получить объект Trees
Returns:
объект DocTrees
Throws:
IllegalArgumentException - если задача не поддерживает API Trees.

instance

public static DocTrees instance(ProcessingEnvironment env)

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

Parameters:
env - среда обработки, для которой требуется получить объект Trees
Returns:
объект DocTrees
Throws:
IllegalArgumentException - если среда не поддерживает API Trees.

getBreakIterator

public abstract BreakIterator getBreakIterator()

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

Returns:
разделитель предложений
Since:
9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(TreePath path)

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

Parameters:
path - путь к узлу дерева
Returns:
дерево комментариев к документации

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(Element e)

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

Parameters:
e - элемент, для которого требуется документация
Returns:
дерево комментариев к документации
Since:
9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(FileObject fileObject)

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

Parameters:
fileObject - контейнер содержимого
Returns:
дерево комментариев к документации
Since:
9

getDocCommentTree

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

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

Parameters:
e - элемент, путь к которому используется в качестве ссылки
relativePath - относительный путь от элемента
Returns:
дерево комментариев к документации
Throws:
IOException - если произошла ошибка
Since:
9

getDocTreePath

public abstract DocTreePath getDocTreePath(FileObject fileObject,
                                           PackageElement packageElement)

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

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

getElement

public abstract Element getElement(DocTreePath path)

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

Parameters:
path - путь к узлу дерева
Returns:
элемент

getFirstSentence

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

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

Parameters:
list - список DocTree для интерпретации
Returns:
первое предложение
Since:
9

getSourcePositions

public abstract DocSourcePositions getSourcePositions()

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

Specified by:
getSourcePositions в классе Trees
Returns:
вспомогательный объект

printMessage

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

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

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

setBreakIterator

public abstract void setBreakIterator(BreakIterator breakiterator)

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

Parameters:
breakiterator - разделитель предложений или null для задания стандартного разделителя предложений
Since:
9

getDocTreeFactory

public abstract DocTreeFactory getDocTreeFactory()

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

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

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

Spec-Zone .ru
спецификации, руководства, описания, API