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

java.lang.Object

com.sun.source.util.Trees

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

public abstract class Trees extends Object

Мостит JSR 199, JSR 269 и API дерева.

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

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

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

Модификатор и тип	Метод	Описание
`abstract String`	`getDocComment(TreePath path)`	Возвращает комментарий к документации, если таковой имеется, для узла `Tree` по заданному `TreePath`.
`abstract Element`	`getElement(TreePath path)`	Возвращает `Element` для узла `Tree` по заданному `TreePath`.
`abstract TypeMirror`	`getLub(CatchTree tree)`	Возвращает наименьший общий предок (lub) параметра исключения, объявленного в блоке 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

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

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 - путь к узлу дерева

Возвращает:

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

См. также:

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)

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

Параметры:: tree - дерево для блока catch
Возвращает:: наименьшую верхнюю границу (lub) параметра исключения

© 1993, 2023, 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/21/docs/api/jdk.compiler/com/sun/source/util/Trees.html