Класс Деревьев

java.lang.Object

com.sun.source.util.Trees

Прямые известные подклассы:: DocTrees

public abstract class Trees extends Object

Связывает JSR 199, JSR 269 и 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)`	Выводит сообщение указанного типа в месте дерева в предоставленном блоке компиляции.

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

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

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

Деревья

public Trees()

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

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

instance

public static Trees instance(JavaCompiler.CompilationTask task)

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

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

instance

public static Trees instance(ProcessingEnvironment env)

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

Параметры:: env - среда обработки, для которой требуется получить объект Trees
Возвращает:: объект Trees
Исключения:: IllegalArgumentException - если среда не поддерживает 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 - путь в дереве

Возвращает:

комментарий к документу

См. также:

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)

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

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

getLub

public abstract TypeMirror getLub(CatchTree tree)

Возвращает наибольший общий предок (lub) параметра исключения, объявленного в блоке catch.

Parameters:: tree - дерево для блока catch
Returns:: наибольший общий предок (lub) параметра исключения

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