Элементы интерфейса

PackageElement getPackageElement(CharSequence name)

Параметры:

name — полное имя пакета или пустая строка для безымянного пакета

Возвращает:

указанный пакет или null, если пакет невозможно однозначно определить.

default PackageElement getPackageElement(ModuleElement module, CharSequence name)

Требования к реализации:

Реализация этого метода по умолчанию возвращает null.

Параметры:

module — модуль, относительно которого следует выполнять поиск

name — полное имя пакета или пустая строка для безымянного пакета

Возвращает:

указанный пакет или null, если его не удалось найти

Начиная с:

9

См. также:

• getAllPackageElements(CharSequence)

default Set<? extends PackageElement> getAllPackageElements(CharSequence name)

Требования к реализации:

Реализация этого метода по умолчанию вызывает getAllModuleElements и сохраняет результат. Если множество модулей пусто, вызывается getPackageElement(name) с переданным аргументом имени. Если getPackageElement(name) равно null, возвращается пустое множество элементов пакетов; в противном случае возвращается множество из одного элемента, содержащие найденный элемент пакета. Если множество модулей не пусто, выполняется перебор модулей, а все результаты вызова getPackageElement(module, name), отличные от null, накапливаются во множестве. Затем это множество возвращается.

Параметры:

name — каноническое имя

Возвращает:

элементы пакетов или пустое множество, если пакет с таким именем не найден

Начиная с:

9

См. также:

• getPackageElement(ModuleElement, CharSequence)

TypeElement getTypeElement(CharSequence name)

Параметры:

name — каноническое имя

Возвращает:

именованный элемент типа или null, если элемент типа невозможно однозначно определить.

default TypeElement getTypeElement(ModuleElement module, CharSequence name)

Требования к реализации:

Реализация этого метода по умолчанию возвращает null.

Параметры:

module — модуль, относительно которого следует выполнять поиск

name — каноническое имя

Возвращает:

именованный элемент типа или null, если его не удалось найти

Начиная с:

9

См. также:

• getAllTypeElements(CharSequence)

default Set<? extends TypeElement> getAllTypeElements(CharSequence name)

Требования к реализации:

Реализация этого метода по умолчанию вызывает getAllModuleElements и сохраняет результат. Если множество модулей пусто, вызывается getTypeElement(name) с переданным аргументом имени. Если getTypeElement(name) равно null, возвращается пустое множество элементов типов; в противном случае возвращается множество из одного элемента, содержащие найденный элемент типа. Если множество модулей не пусто, выполняется перебор модулей, а все результаты вызова getTypeElement(module, name), отличные от null, накапливаются во множестве. Затем это множество возвращается.

Параметры:

name — каноническое имя

Возвращает:

элементы типов или пустое множество, если тип с таким именем не найден

Начиная с:

9

См. также:

• getTypeElement(ModuleElement, CharSequence)

default ModuleElement getModuleElement(CharSequence name)

Требования к реализации:

Реализация этого метода по умолчанию возвращает null.

Параметры:

name — имя или пустая строка для безымянного модуля

Возвращает:

именованный элемент модуля или null, если его не удалось найти

Начиная с:

9

См. также:

• getAllModuleElements()

default Set<? extends ModuleElement> getAllModuleElements()

Примечание API:

Если среда включает модули, могут возвращаться как именованные, так и безымянные модули.

Требования к реализации:

Реализация этого метода по умолчанию возвращает пустое множество.

Возвращает:

известные элементы модулей или пустое множество, если модулей нет

Начиная с:

9

См. также:

• getModuleElement(CharSequence)

Map<? extends ExecutableElement, ? extends AnnotationValue> getElementValuesWithDefaults(AnnotationMirror a)

Параметры:

a — проверяемая аннотация

Возвращает:

значения элементов аннотации, включая значения по умолчанию

См. также:

• AnnotationMirror.getElementValues()

String getDocComment(Element e)

Примечание API:

Комментарии документации обрабатываются стандартным doclet, используемым инструментом javadoc для создания документации API.

Параметры:

e — проверяемый элемент

Возвращает:

комментарий документации элемента или null, если его нет

См. Спецификацию языка Java:

3.6 Пробельные символы
3.7 Комментарии

default Elements.DocCommentKind getDocCommentKind(Element e)

Требования к реализации:

Реализация этого метода по умолчанию возвращает null.

Параметры:

e — проверяемый элемент

Возвращает:

вид комментария документации для заданного элемента или null, если комментария нет либо его вид неизвестен

Начиная с:

23

boolean isDeprecated(Element e)

Параметры:

e — проверяемый элемент

Возвращает:

true, если элемент устарел, и false в противном случае

default Elements.Origin getOrigin(Element e)

Требования к реализации:

Реализация этого метода по умолчанию возвращает EXPLICIT.

Параметры:

e — проверяемый элемент

Возвращает:

происхождение заданного элемента

Начиная с:

9

default Elements.Origin getOrigin(AnnotatedConstruct c, AnnotationMirror a)

Требования к реализации:

Реализация этого метода по умолчанию возвращает EXPLICIT.

Параметры:

c — конструкция, которую изменяет зеркало аннотации

a — проверяемое зеркало аннотации

Возвращает:

происхождение заданного зеркала аннотации

См. Спецификацию языка Java:

9.6.3 Повторяемые интерфейсы аннотаций
9.7.5 Несколько аннотаций одного интерфейса

Начиная с:

9

default Elements.Origin getOrigin(ModuleElement m, ModuleElement.Directive directive)

Требования к реализации:

Реализация этого метода по умолчанию возвращает EXPLICIT.

Параметры:

m — модуль, к которому относится директива

directive — проверяемая директива модуля

Возвращает:

происхождение заданной директивы модуля

Начиная с:

9

default boolean isBridge(ExecutableElement e)

Требования к реализации:

Реализация этого метода по умолчанию возвращает false.

Параметры:

e — проверяемый исполняемый элемент

Возвращает:

true, если исполняемый элемент является мостовым методом, и false в противном случае

Начиная с:

9

Name getBinaryName(TypeElement type)

Параметры:

type — проверяемый элемент типа

Возвращает:

бинарное имя элемента типа

См. Спецификацию языка Java:

13.1 Форма бинарного представления

См. также:

• TypeElement.getQualifiedName()

PackageElement getPackageOf(Element e)

Параметры:

e — проверяемый элемент

Возвращает:

пакет элемента

default ModuleElement getModuleOf(Element e)

Требования к реализации:

Реализация этого метода по умолчанию возвращает null.

Параметры:

e — проверяемый элемент

Возвращает:

модуль элемента

Начиная с:

9

List<? extends Element> getAllMembers(TypeElement type)

Примечание API:

Элементы определённых видов можно выделить с помощью методов класса ElementFilter.

Параметры:

type — проверяемый тип

Возвращает:

все члены типа

См. также:

• Element.getEnclosedElements()

default TypeElement getOutermostTypeElement(Element e)

Требования к реализации:

Реализация этого метода по умолчанию сначала проверяет вид аргумента. Для элементов видов PACKAGE, MODULE и OTHER возвращается null. Для элементов других видов проверяется, является ли элемент классом или интерфейсом верхнего уровня. Если да, возвращается этот элемент; в противном случае выполняется переход по цепочке внешних элементов, пока не будет найден класс или интерфейс верхнего уровня. Возвращается элемент, соответствующий найденному классу или интерфейсу верхнего уровня.

Параметры:

e — проверяемый элемент

Возвращает:

самый внешний элемент типа, в который входит элемент, если такой содержащий элемент существует; в противном случае возвращает null

Начиная с:

18

См. также:

• Element.getEnclosingElement()

List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e)

Параметры:

e — проверяемый элемент

Возвращает:

все аннотации элемента

См. также:

• Element.getAnnotationMirrors()
• AnnotatedConstruct

boolean hides(Element hider, Element hidden)

Параметры:

hider — первый элемент

hidden — второй элемент

Возвращает:

true тогда и только тогда, когда первый элемент скрывает второй

См. Спецификацию языка Java:

8.4.8 Наследование, переопределение и сокрытие

boolean overrides(ExecutableElement overrider, ExecutableElement overridden, TypeElement type)

interface I {
  @Override
  String toString();
}
...
assert elements.overrides(elementForItoString,
                          elementForObjecttoString,
                          elements.getTypeElement("I"));

Примечание к API:

При определении того, переопределяет ли один метод другой, этот метод проверяет имя метода, сигнатуру, отношение подкласса и доступность, как указано в JLS 8.4.8.1. Кроме того, реализация может выполнять более строгие проверки, включая проверку модификаторов методов, типов возвращаемых значений и типов исключений, как описано в JLS 8.4.8.1 и 8.4.8.3. Обратите внимание, что такие дополнительные проверки во время компиляции не гарантируются и могут различаться в разных реализациях.

Параметры:

overrider — первый метод, возможно переопределяющий

overridden — второй метод, возможно переопределяемый

type — класс или интерфейс, членом которого является первый метод

Возвращает:

true тогда и только тогда, когда первый метод переопределяет второй

См. Спецификацию языка Java:

8.4.8 Наследование, переопределение и сокрытие
9.4.1 Наследование и переопределение

String getConstantExpression(Object value)

Параметры:

value — примитивное значение или строка

Возвращает:

текст константного выражения

Вызывает:

IllegalArgumentException — если аргумент не является примитивным значением или строкой

См. также:

• VariableElement.getConstantValue()

void printElements(Writer w, Element... elements)

Параметры:

w — объект записи, в который выводятся данные

elements — элементы для вывода

Name getName(CharSequence cs)

Параметры:

cs — последовательность символов, которую нужно вернуть в качестве имени

Возвращает:

имя с той же последовательностью символов, что и аргумент

boolean isFunctionalInterface(TypeElement type)

Параметры:

type — проверяемый элемент типа

Возвращает:

true, если элемент типа является функциональным интерфейсом, и false в противном случае

См. Спецификацию языка Java:

9.8 Функциональные интерфейсы

Начиная с:

1.8

default boolean isAutomaticModule(ModuleElement module)

Требования к реализации:

Реализация этого метода по умолчанию возвращает false.

Параметры:

module — проверяемый элемент модуля

Возвращает:

true, если элемент модуля является автоматическим модулем, и false в противном случае

См. Спецификацию языка Java:

7.7.1 Зависимости

Начиная с:

17

default TypeElement getEnumConstantBody(VariableElement enumConstant)

Требования к реализации:

Реализация этого метода по умолчанию выбрасывает UnsupportedOperationException, если аргумент является константой enum, и выбрасывает IllegalArgumentException, если это не так.

Параметры:

enumConstant — константа перечисления

Возвращает:

тело класса константы enum, если аргумент является константой enum, объявленной с необязательным телом класса, и null в противном случае

Вызывает:

IllegalArgumentException — если аргумент не является константой enum

См. Спецификацию языка Java:

8.9.1 Константы перечисления

Начиная с:

22

default RecordComponentElement recordComponentFor(ExecutableElement accessor)

Требования к реализации:

Реализация этого метода по умолчанию проверяет, имеет ли элемент, содержащий метод доступа, вид RECORD. Если да, то все компоненты записи содержащего элемента метода доступа отбираются вызовом ElementFilter.recordComponentsIn(Iterable). Если метод доступа хотя бы одного из полученных компонентов записи совпадает с методом доступа, переданным этому методу в качестве параметра, возвращается этот компонент записи; в противном случае возвращается null.

Параметры:

accessor — метод, для которого нужно найти компонент записи.

Возвращает:

компонент записи или null, если заданный метод не является методом доступа к компоненту записи

Начиная с:

16

default boolean isCanonicalConstructor(ExecutableElement e)

Требования к реализации:

Реализация этого метода по умолчанию всегда возвращает false.

Параметры:

e — проверяемый исполняемый элемент

Возвращает:

true, если можно определить, что исполняемый элемент является каноническим конструктором записи, и false в противном случае

См. Спецификацию языка Java:

8.10.4.1 Обычные канонические конструкторы

Начиная с:

20

default boolean isCompactConstructor(ExecutableElement e)

Требования к реализации:

Реализация этого метода по умолчанию всегда возвращает false.

Параметры:

e — проверяемый исполняемый элемент

Возвращает:

true, если можно определить, что исполняемый элемент является компактным конструктором записи, и false в противном случае

См. Спецификацию языка Java:

8.10.4.2 Компактные канонические конструкторы

Начиная с:

20

default JavaFileObject getFileObjectOf(Element e)

Требования к реализации:

Реализация по умолчанию всегда выбрасывает UnsupportedOperationException.

Параметры:

e — элемент, для которого нужно найти файловый объект

Возвращает:

файловый объект для этого элемента или null, если такого файлового объекта нет

Вызывает:

UnsupportedOperationException — если эта функциональность не поддерживается

Начиная с:

18