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

PackageElement getPackageElement(CharSequence name)

Возвращает пакет по его полному квалифицированному имени, если пакет однозначно определяется в среде. При работе с модулями пакеты с заданным именем ищутся в двухэтапном процессе:

• находятся непустые пакеты с заданным именем, возвращаемые getPackageElement(ModuleElement, CharSequence), где предоставленный ModuleSymbol является любым корневым модулем,
• если вышеуказанный поиск не дал результатов, то происходит поиск в all modules наблюдаемых пакетов с заданным именем

Если этот процесс приводит к списку с одним элементом, то возвращается этот элемент, в противном случае возвращается null.

default PackageElement getPackageElement(ModuleElement module, CharSequence name)

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

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

Возвращает все элементы пакетов с заданным каноническим именем. Может быть более одного элемента пакета с одинаковым каноническим именем, если элементы пакета находятся в разных модулях.

TypeElement getTypeElement(CharSequence name)

Возвращает элемент типа по его каноническому имени, если элемент типа однозначно определяется в среде. При работе с модулями элементы типа с заданным именем ищутся в двухэтапном процессе:

• находятся элементы типа с заданным именем, возвращаемые getTypeElement(ModuleElement, CharSequence), где предоставленный ModuleSymbol является любым корневым модулем,
• если вышеуказанный поиск не дал результатов, то происходит поиск в all modules наблюдаемых элементов типа с заданным именем

Если этот процесс приводит к списку с одним элементом, то возвращается этот элемент, в противном случае возвращается null.

default TypeElement getTypeElement(ModuleElement module, CharSequence name)

Возвращает элемент типа по его каноническому имени, как видно из данного модуля.

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

Возвращает все элементы типа с заданным каноническим именем. Может быть более одного элемента типа с одинаковым каноническим именем, если элементы типа находятся в разных модулях.

default ModuleElement getModuleElement(CharSequence name)

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

default Set<? extends ModuleElement> getAllModuleElements()

Возвращает все элементы модулей в текущей среде. Если модулей нет, возвращается пустой набор. Одна из ситуаций, когда модулей нет, возникает, когда среда не включает модулей, например, среда обработки аннотаций, настроенная для версии исходного кода без модулей.

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

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

String getDocComment(Element e)

Возвращает текст документационного («Javadoc») комментария элемента.

Документационный комментарий элемента — это комментарий, начинающийся с "/**", заканчивающийся отдельным "*/", и непосредственно предшествующий элементу, игнорируя пробелы. Следовательно, документационный комментарий содержит как минимум три "*" символа. Возвращаемый текст документационного комментария — это обработанная форма комментария, как он выглядит в исходном коде. Ведущие "/**" и заключительные "*/" удаляются. Для строк комментария, начинающихся после начального "/**", ведущие пробелы отбрасываются, как и любые последовательные "*" символы, появляющиеся после пробелов или в начале строки. Обработанные строки затем конкатенируются вместе (включая символы конца строки) и возвращаются.

boolean isDeprecated(Element e)

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

default Elements.Origin getOrigin(Element e)

Возвращает источник данного элемента.

Обратите внимание, что если этот метод возвращает EXPLICIT, и элемент был создан из файла класса, то элемент может фактически не соответствовать явно объявленной конструкции в исходном коде. Это связано с ограничениями точности формата файла класса при сохранении информации из исходного кода. Например, по крайней мере, некоторые версии формата файла класса не сохраняют информацию о том, был ли конструктор явно объявлен программистом или был неявно объявлен как конструктор по умолчанию.

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

Возвращает источник данного зеркала аннотации. Зеркало аннотации является обязательным, если это неявно объявленная контейнерная аннотация, используемая для хранения повторяющихся аннотаций интерфейса повторяемой аннотации.

Обратите внимание, что если этот метод возвращает EXPLICIT, и зеркало аннотации было создано из файла класса, то элемент может фактически не соответствовать явно объявленной конструкции в исходном коде. Это связано с ограничениями точности формата файла класса при сохранении информации из исходного кода. Например, по крайней мере, некоторые версии формата файла класса не сохраняют информацию о том, была ли аннотация явно объявлена программистом или была неявно объявлена как контейнерная аннотация.

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

Возвращает источник данного директивы модуля.

Обратите внимание, что если этот метод возвращает EXPLICIT, и директива модуля была создана из файла класса, то директива модуля может фактически не соответствовать явно объявленной конструкции в исходном коде. Это связано с ограничениями точности формата файла класса при сохранении информации из исходного кода. Например, по крайней мере, некоторые версии формата файла класса не сохраняют информацию о том, была ли директива uses явно объявлена программистом или была добавлена как синтетическая конструкция.

Обратите внимание, что реализация может не быть в состоянии надежно определить статус источника директивы, если директива создана из файла класса, из-за ограничений точности формата файла класса при сохранении информации из исходного кода.

default boolean isBridge(ExecutableElement e)

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

Name getBinaryName(TypeElement type)

Возвращает бинарное имя элемента типа.

PackageElement getPackageOf(Element e)

Возвращает пакет элемента. Пакет пакета - это сам пакет. Пакет модуля - null. Пакет класса или интерфейса верхнего уровня - это его вложенный пакет. В противном случае пакет элемента равен пакету вложенного элемента.

default ModuleElement getModuleOf(Element e)

Возвращает модуль элемента. Модуль модуля - это сам модуль. Если пакет имеет модуль в качестве своего вложенного элемента, этот модуль является модулем пакета. Если вложенный элемент пакета - null, null возвращается для модуля пакета. (Один из случаев, когда пакет может иметь null модуль, - если среда не включает модули, например, среда обработки аннотаций, настроенная для версии исходного кода без модулей.) В противном случае модуль элемента равен модулю пакета элемента.

List<? extends Element> getAllMembers(TypeElement type)

Возвращает все члены элемента типа, унаследованные или объявленные непосредственно. Для класса результаты также включают его конструкторы, но не локальные или анонимные классы.

List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e)

Возвращает все аннотации, присутствующие на элементе, присутствующие как непосредственно, так и через наследование.

Обратите внимание, что любые аннотации, возвращаемые этим методом, являются аннотациями объявления.

boolean hides(Element hider, Element hidden)

Проверяет, скрывает ли один тип, метод или поле другой.

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

Проверяет, переопределяет ли один метод, как член заданного класса или интерфейса, другой метод. Когда неабстрактный метод переопределяет абстрактный, считается, что первый также реализует второй.

В самом простом и типичном случае значение параметра type просто будет классом или интерфейсом, непосредственно содержащим overrider (возможно, переопределяющий метод). Например, предположим, что m1 представляет метод String.hashCode, а m2 представляет Object.hashCode. Тогда мы можем спросить, переопределяет ли m1 метод m2 внутри класса String (да, переопределяет):

assert elements.overrides(m1, m2, elements.getTypeElement("java.lang.String"));

Более интересный случай можно проиллюстрировать на следующем примере, в котором метод в классе A не переопределяет одноимённый метод в интерфейсе B:

class A { public void m() {} }
interface B { void m(); }
...
m1 = ...; // A.m
m2 = ...; // B.m
assert ! elements.overrides(m1, m2, elements.getTypeElement("A"));

Однако, если рассматривать этот метод как член третьего класса C, метод в A переопределяет метод в B:

class C extends A implements B {}
...
assert elements.overrides(m1, m2, elements.getTypeElement("C"));

String getConstantExpression(Object value)

Возвращает текст константного выражения, представляющего примитивное значение или строку. Возвращаемый текст имеет формат, подходящий для представления значения в исходном коде.

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

Выводит представление элементов в заданный поток в указанном порядке. Основное назначение этого метода — для диагностики. Точный формат вывода не определён и может быть изменён.

Name getName(CharSequence cs)

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

boolean isFunctionalInterface(TypeElement type)

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

default boolean isAutomaticModule(ModuleElement module)

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

default RecordComponentElement recordComponentFor(ExecutableElement accessor)

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