Класс Trees

Прямые известные подклассы:
DocTrees
public abstract class Trees
extends Object

Связывает JSR 199, JSR 269 и API дерева.

Конструкторы

Конструктор Описание
Trees()

Методы

Модификатор и тип Метод Описание
abstract String getDocComment​(TreePath path)

Возвращает комментарий к документу, если таковой имеется, для узла дерева, идентифицированного заданным TreePath.
abstract Element getElement​(TreePath path)

Возвращает Element для узла дерева, идентифицированного заданным 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 для узла дерева, идентифицированного заданным TreePath.
abstract SourcePositions getSourcePositions()

Возвращает служебный объект для получения позиций в исходном коде.
abstract Tree getTree​(Element element)

Возвращает узел дерева для заданного Element.
abstract Tree getTree​(Element e, AnnotationMirror a)

Возвращает узел дерева для AnnotationMirror на заданном Element.
abstract Tree getTree​(Element e, AnnotationMirror a, AnnotationValue v)

Возвращает узел дерева для AnnotationValue для AnnotationMirror на заданном Element.
abstract MethodTree getTree​(ExecutableElement method)

Возвращает узел MethodTree для заданного ExecutableElement.
abstract ClassTree getTree​(TypeElement element)

Возвращает узел ClassTree для заданного TypeElement.
abstract TypeMirror getTypeMirror​(TreePath path)

Возвращает TypeMirror для узла дерева, идентифицированного заданным 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)

Проверяет, доступен ли заданный элемент в качестве члена заданного типа в заданном scope.
abstract boolean isAccessible​(Scope scope, TypeElement type)

Проверяет, доступен ли заданный тип в заданном scope.
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 Trees.

instance

public static Trees instance(ProcessingEnvironment env)

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

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

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 на заданном элементе. Возвращает null если узел не найден.

Параметры:
e - элемент
a - зеркало аннотации
Возвращает:
узел дерева

getTree

public abstract Tree getTree(Element e,
                             AnnotationMirror a,
                             AnnotationValue v)

Возвращает узел дерева Tree для AnnotationValue для AnnotationMirror на заданном элементе. Возвращает null если узел не найден.

Параметры:
e - элемент
a - зеркало аннотации
v - значение аннотации
Возвращает:
узел дерева

getPath

public abstract TreePath getPath(CompilationUnitTree unit,
                                 Tree node)

Возвращает путь к узлу дерева в заданном блоке компиляции.

Параметры:
unit - блок компиляции
node - узел дерева
Возвращает:
путь к узлу дерева

getPath

public abstract TreePath getPath(Element e)

Возвращает узел TreePath для заданного элемента. Возвращает null если узел не найден.

Параметры:
e - элемент
Возвращает:
путь к узлу дерева

getPath

public abstract TreePath getPath(Element e,
                                 AnnotationMirror a)

Возвращает узел TreePath для AnnotationMirror на заданном элементе. Возвращает null если узел не найден.

Параметры:
e - элемент
a - зеркало аннотации
Возвращает:
путь к узлу дерева

getPath

public abstract TreePath getPath(Element e,
                                 AnnotationMirror a,
                                 AnnotationValue v)

Возвращает узел TreePath для AnnotationValue для AnnotationMirror на заданном элементе. Возвращает null если узел не найден.

Параметры:
e - элемент
a - зеркало аннотации
v - значение аннотации
Возвращает:
путь к узлу дерева

getElement

public abstract Element getElement(TreePath path)

Возвращает элемент Element для узла дерева, определенного заданным TreePath. Возвращает null если элемент недоступен.

Параметры:
path - путь к узлу дерева
Возвращает:
элемент
Исключения:
IllegalArgumentException - если TreePath не определяет узел дерева, который может иметь связанный элемент.

getTypeMirror

public abstract TypeMirror getTypeMirror(TreePath path)

Возвращает TypeMirror для узла дерева, определенного заданным TreePath. Возвращает null если TypeMirror недоступен.

Параметры:
path - путь к узлу дерева
Возвращает:
зеркало типа
Исключения:
IllegalArgumentException - если TreePath не определяет узел дерева, который может иметь связанное TypeMirror.

getScope

public abstract Scope getScope(TreePath path)

Возвращает Scope для узла дерева, определенного заданным TreePath. Возвращает null если Scope недоступен.

Параметры:
path - путь к узлу дерева
Возвращает:
область видимости

getDocComment

public abstract String getDocComment(TreePath path)

Возвращает комментарий документации, если он есть, для узла дерева, определенного заданным 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, для которого требуется получить исходный тип.
Возвращает:
javax.lang.model.type.TypeMirror, соответствующий исходному типу, заменённому 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, 2020, 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/11/docs/api/jdk.compiler/com/sun/source/util/Trees.html

Spec-Zone .ru
спецификации, руководства, описания, API