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

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)

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

default TypeElement getOutermostTypeElement(Element e)

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

List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e)

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

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

boolean hides(Element hider, Element hidden)

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

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

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

В простейшем и типичном использовании, значение параметра 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, если данный метод не является методом доступа к компоненту записи.

default boolean isCanonicalConstructor(ExecutableElement e)

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

default boolean isCompactConstructor(ExecutableElement e)

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

default JavaFileObject getFileObjectOf(Element e)

Возвращает объект файла для данного элемента или null , если такого объекта файла нет.

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

Реализация может выбрать не поддерживать функциональность этого метода, в этом случае выбрасывается UnsupportedOperationException.

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

Если у него есть объект файла, объект файла для пакета будет файлом package-info. Пакет может существовать и не иметь файла package-info, даже если пакет (неявно) создаётся во время выполнения обработки аннотаций из создания исходных или файлов класса в этом пакете. У безымянного пакета будет файл null, так как он не может быть объявлен в единице компиляции.

Если у него есть объект файла, объект файла для модуля будет файлом module-info. У безымянного модуля будет файл null, так как он не может быть объявлен в единице компиляции. У автоматического модуля будет файл null, так как он неявно объявлен.

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

Для вложенного класса или интерфейса, если у него есть объект файла:

• если исходный файл предоставляет представление ссылки, объект файла будет объектом внешнего окружающего класса или интерфейса
• если файл класса предоставляет представление ссылки, объект файла будет объектом самого вложенного класса или интерфейса

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