Spec-Zone.ru › OpenJDK 27

Дерево классов

java.lang.Object
com.sun.source.util.Trees
Прямые известные подклассы:
DocTrees
public abstract class Trees extends Object
Обеспечивает взаимодействие JSR 199, JSR 269 и Tree API.
С версии:
1.6

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

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

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

Модификатор и тип Метод Описание
abstract String getDocComment(TreePath path)
Возвращает комментарий документации, если он есть, для узла Tree, определяемого заданным TreePath.
abstract Element getElement(TreePath path)
Возвращает Element для узла Tree, определяемого заданным TreePath.
abstract TypeMirror getLub(CatchTree tree)
Возвращает наименьшую верхнюю грань исключения, объявленного в предложении catch.
abstract TypeMirror getOriginalType(ErrorType errorType)
Возвращает исходный тип из объекта ErrorType.
abstract TreePath getPath(CompilationUnitTree unit, Tree node)
Возвращает путь к узлу дерева в указанной единице компиляции.
abstract TreePath getPath(Element e)
Возвращает узел TreePath для заданного Element.
abstract TreePath getPath(Element e, AnnotationMirror a)
Возвращает узел TreePath для AnnotationMirror в заданном Element.
abstract TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v)
Возвращает узел TreePath для AnnotationValue у AnnotationMirror в заданном Element.
abstract Scope getScope(TreePath path)
Возвращает Scope для узла Tree, определяемого заданным TreePath.
abstract SourcePositions getSourcePositions()
Возвращает вспомогательный объект для получения позиций в исходном коде.
abstract Tree getTree(Element element)
Возвращает узел Tree для заданного Element.
abstract Tree getTree(Element e, AnnotationMirror a)
Возвращает узел Tree для AnnotationMirror в заданном Element.
abstract Tree getTree(Element e, AnnotationMirror a, AnnotationValue v)
Возвращает узел Tree для AnnotationValue у AnnotationMirror в заданном Element.
abstract MethodTree getTree(ExecutableElement method)
Возвращает узел MethodTree для заданного ExecutableElement.
abstract ClassTree getTree(TypeElement element)
Возвращает узел ClassTree для заданного TypeElement.
abstract TypeMirror getTypeMirror(TreePath path)
Возвращает TypeMirror для узла Tree, определяемого заданным TreePath.
static Trees instance(ProcessingEnvironment env)
Возвращает объект Trees для заданного ProcessingEnvironment.
static Trees instance(JavaCompiler.CompilationTask task)
Возвращает объект Trees для заданного CompilationTask.
abstract boolean isAccessible(Scope scope, Element member, DeclaredType type)
Проверяет, доступен ли заданный элемент как член заданного типа в заданной области видимости.
abstract boolean isAccessible(Scope scope, TypeElement type)
Проверяет, доступен ли заданный тип в заданной области видимости.
abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root)
Выводит сообщение указанного типа в месте расположения дерева в заданной единице компиляции

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создает и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли этот объект какому-либо другому.
protected void finalize()
Устарело, планируется удаление: этот элемент API подлежит удалению в будущей версии.
Финализация устарела и подлежит удалению в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно вследствие уведомления или прерывания.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно вследствие уведомления или прерывания, либо до истечения заданного промежутка реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно вследствие уведомления или прерывания, либо до истечения заданного промежутка реального времени.

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

Trees

public Trees()
Конструктор для вызова из подклассов.

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

instance

public static Trees instance(JavaCompiler.CompilationTask task)
Возвращает объект Trees для заданного CompilationTask.
Параметры:
task — задача компиляции, для которой нужно получить объект Trees
Возвращает:
объект Trees
Вызывает исключение:
IllegalArgumentException — если задача не поддерживает Tree API.

instance

public static Trees instance(ProcessingEnvironment env)
Возвращает объект Trees для заданного ProcessingEnvironment.
Параметры:
env — среда обработки, для которой нужно получить объект Trees
Возвращает:
объект Trees
Вызывает исключение:
IllegalArgumentException — если среда не поддерживает Tree API.

getSourcePositions

public abstract SourcePositions getSourcePositions()
Возвращает вспомогательный объект для получения позиций в исходном коде.
Возвращает:
вспомогательный объект для получения позиций в исходном коде

getTree

public abstract Tree getTree(Element element)
Возвращает узел Tree для заданного Element. Возвращает null, если узел не найден.
Параметры:
element — элемент
Возвращает:
узел дерева

getTree

public abstract ClassTree getTree(TypeElement element)
Возвращает узел ClassTree для заданного TypeElement. Возвращает null, если узел не найден.
Параметры:
element — элемент
Возвращает:
узел дерева класса

getTree

public abstract MethodTree getTree(ExecutableElement method)
Возвращает узел MethodTree для заданного ExecutableElement. Возвращает null, если узел не найден.
Параметры:
method — исполняемый элемент
Возвращает:
узел дерева метода

getTree

public abstract Tree getTree(Element e, AnnotationMirror a)
Возвращает узел Tree для AnnotationMirror у заданного Element. Возвращает null, если узел не найден.
Параметры:
e — элемент
a — зеркало аннотации
Возвращает:
узел дерева

getTree

public abstract Tree getTree(Element e, AnnotationMirror a, AnnotationValue v)
Возвращает узел Tree для AnnotationValue значения AnnotationMirror у заданного Element. Возвращает null, если узел не найден.
Параметры:
e — элемент
a — зеркало аннотации
v — значение аннотации
Возвращает:
узел дерева

getPath

public abstract TreePath getPath(CompilationUnitTree unit, Tree node)
Возвращает путь к узлу дерева в указанной единице компиляции.
Параметры:
unit — единица компиляции
node — узел дерева
Возвращает:
путь дерева

getPath

public abstract TreePath getPath(Element e)
Возвращает узел TreePath для заданного Element. Возвращает null, если узел не найден.
Параметры:
e — элемент
Возвращает:
путь дерева

getPath

public abstract TreePath getPath(Element e, AnnotationMirror a)
Возвращает узел TreePath для AnnotationMirror у заданного Element. Возвращает null, если узел не найден.
Параметры:
e — элемент
a — зеркало аннотации
Возвращает:
путь дерева

getPath

public abstract TreePath getPath(Element e, AnnotationMirror a, AnnotationValue v)
Возвращает узел TreePath для AnnotationValue значения AnnotationMirror у заданного Element. Возвращает null, если узел не найден.
Параметры:
e — элемент
a — зеркало аннотации
v — значение аннотации
Возвращает:
путь дерева

getElement

public abstract Element getElement(TreePath path)
Возвращает Element для узла Tree, определяемого заданным TreePath. Возвращает null, если элемент недоступен.
Параметры:
path — путь дерева
Возвращает:
элемент
Вызывает исключение:
IllegalArgumentException — если TreePath не указывает на узел Tree, с которым может быть связан Element.

getTypeMirror

public abstract TypeMirror getTypeMirror(TreePath path)
Возвращает TypeMirror для узла Tree, определяемого заданным TreePath. Возвращает null, если TypeMirror недоступен.
Параметры:
path — путь дерева
Возвращает:
зеркало типа
Вызывает исключение:
IllegalArgumentException — если TreePath не указывает на узел Tree, с которым может быть связан TypeMirror.

getScope

public abstract Scope getScope(TreePath path)
Возвращает Scope для узла Tree, определяемого заданным TreePath. Возвращает null, если Scope недоступна.
Параметры:
path — путь дерева
Возвращает:
область видимости

getDocComment

public abstract String getDocComment(TreePath path)
Возвращает комментарий документации, если он есть, для узла Tree, определяемого заданным TreePath. Возвращает null, если комментарий документации не найден.
Параметры:
path — путь дерева
Возвращает:
комментарий документации
См. также:
  • DocTrees.getDocCommentTree(TreePath)

isAccessible

public abstract boolean isAccessible(Scope scope, TypeElement type)
Проверяет, доступен ли заданный тип в заданной области видимости.
Параметры:
scope — проверяемая область видимости
type — проверяемый тип
Возвращает:
true, если type доступен

isAccessible

public abstract boolean isAccessible(Scope scope, Element member, DeclaredType type)
Проверяет, доступен ли заданный элемент как член заданного типа в заданной области видимости.
Параметры:
scope — проверяемая область видимости
member — проверяемый член
type — тип, для которого проверяется доступность члена
Возвращает:
true, если member доступен в type

getOriginalType

public abstract TypeMirror getOriginalType(ErrorType errorType)
Возвращает исходный тип из объекта ErrorType.
Параметры:
errorType — errorType, для которого требуется получить исходный тип
Возвращает:
зеркало типа, соответствующее исходному типу, заменённое на ErrorType

printMessage

public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root)
Выводит сообщение указанного типа в месте расположения дерева в заданной единице компиляции
Параметры:
kind — тип сообщения
msg — сообщение или пустая строка, если сообщения нет
t — дерево, используемое в качестве подсказки о позиции
root — единица компиляции, содержащая дерево

getLub

public abstract TypeMirror getLub(CatchTree tree)
Возвращает наименьшую верхнюю грань исключения, объявленного в предложении catch.
Параметры:
tree — дерево для предложения catch
Возвращает:
наименьшую верхнюю грань параметра-исключения

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры основных понятий, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её дочерних компаний в США и других странах.
Авторские права © 1993, 2026, Oracle и/или её дочерние компании, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

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