Spec-Zone.ru › OpenJDK 24

Класс DocTrees

java.lang.Object
com.sun.source.util.Trees
com.sun.source.util.DocTrees
public abstract class DocTrees extends Trees
Предоставляет доступ к синтаксическим деревьям для комментариев документации.
Since:
1.8

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

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

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

Модификатор и тип Метод Описание
abstract BreakIterator getBreakIterator()
Возвращает итератор разбиения, используемый для вычисления первого предложения комментариев документации.
abstract String getCharacters(EntityTree tree)
Возвращает строку, содержащую символы для сущности в заданном дереве сущностей, или null, если дерево не представляет собой допустимую последовательность символов.
abstract Elements.DocCommentKind getDocCommentKind(TreePath path)
Возвращает стиль комментария документации, связанного с узлом дерева.
abstract DocCommentTree getDocCommentTree(TreePath path)
Возвращает дерево комментариев документации, если таковое имеется, для узла дерева, определённого заданным 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

getDocCommentKind

public abstract Elements.DocCommentKind getDocCommentKind(TreePath path)
Возвращает стиль комментария к документации, связанный с узлом дерева.
Параметры:
path - путь к узлу дерева
Возвращает:
стиль комментария к документации, связанный с узлом дерева
С момента:
23
См. также:
  • Trees.getPath(Element)

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(TreePath path)
Возвращает дерево комментария к документации, если оно есть, для узла дерева, определенного заданным TreePath. Возвращает null, если комментарий к документации не был найден.
Замечание по реализации:
Реализация по умолчанию этого метода возвращает тот же DocCommentTree экземпляр для повторных вызовов с тем же аргументом.
Параметры:
path - путь к узлу дерева
Возвращает:
дерево комментария к документации

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(Element e)
Возвращает дерево комментария к документации заданного элемента. Возвращает null, если комментарий к документации не был найден.
Замечание по реализации:
Реализация по умолчанию этого метода возвращает тот же DocCommentTree экземпляр для повторных вызовов с тем же аргументом.
Параметры:
e - элемент, для которого требуется документация
Возвращает:
дерево комментария к документации
С момента:
9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(FileObject fileObject)
Возвращает дерево комментария к документации заданного файла, который должен быть одного из поддерживаемых типов файлов.

Поддерживаемые типы файлов:

  • Файлы HTML, определяемые именем файла, заканчивающимся на .html,
  • Файлы Markdown, определяемые именем файла, заканчивающимся на .md.
Будущие релизы могут поддерживать дополнительные типы файлов.
Замечание по реализации:
Реализация по умолчанию этого метода возвращает новый DocCommentTree экземпляр для каждого вызова.
Параметры:
fileObject - контейнер содержимого
Возвращает:
дерево комментария к документации
Исключения:
IllegalArgumentException - если тип файла не поддерживается
С момента:
9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException
Возвращает дерево комментария к документации заданного файла, который должен быть одного из поддерживаемых типов файлов, и чья путь указан относительно заданного элемента.

Поддерживаемые типы файлов:

  • Файлы HTML, определяемые именем файла, заканчивающимся на .html,
  • Файлы Markdown, определяемые именем файла, заканчивающимся на .md.
Будущие релизы могут поддерживать дополнительные типы файлов.
Замечание по реализации:
Реализация по умолчанию этого метода возвращает новый DocCommentTree экземпляр для каждого вызова.
Параметры:
e - элемент, путь которого используется в качестве ссылки
relativePath - относительный путь от элемента
Возвращает:
дерево комментария к документации
Исключения:
IOException - если произошла ошибка
IllegalArgumentException - если тип файла не поддерживается
С момента:
9

getDocTreePath

public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)
Возвращает путь к дереву документации, содержащий дерево комментария к документации заданного файла, который должен быть одного из поддерживаемых типов файлов. Поддерживаемые типы файлов — файлы HTML и Markdown. Будущие релизы могут поддерживать дополнительные типы файлов. Любые ссылки на элементы исходного кода, содержащиеся в @see и {@link} тегах в дереве комментария к документации, будут оцениваться в контексте заданного элемента пакета. Возвращает null, если комментарий к документации не был найден.
Параметры:
fileObject - объект файла, содержащий HTML-содержимое
packageElement - элемент пакета для ассоциации с заданным объектом файла, представляющим устаревший пакет.html, иначе null
Возвращает:
путь к дереву документации, содержащий дерево комментариев к документации, проанализированное из заданного файла
Исключения:
IllegalArgumentException - если тип файла не поддерживается
С момента:
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.

Parameters:
tree - дерево, содержащее сущность
Returns:
строка, содержащая символы
Since:
16
External Specifications
  • Стандарт HTML

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/jdk.compiler/com/sun/source/util/DocTrees.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API