Spec-Zone.ru › OpenJDK 25

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

java.lang.Object
com.sun.source.util.Trees
Прямые известные подклассы:
DocTrees
public abstract class Trees extends Object
Связывает JSR 199, JSR 269 и API Tree.
Начиная с версии:
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

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

Trees

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

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

instance

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

instance

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

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, 2025, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.compiler/com/sun/source/util/Trees.html

Spec-Zone.ru

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