compact3

javax.lang.model.util

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

public interface Elements

Служебные методы для того, чтобы работать на элементах программы.

Примечание совместимости: Методы могут быть добавлены к этому интерфейсу в будущих выпусках платформы.

С тех пор:

1.6

См. Также:

ProcessingEnvironment.getElementUtils()

Сводка метода

Модификатор и Тип	Метод и Описание
List<? extends AnnotationMirror>	getAllAnnotationMirrors(Element e) Возвраты все аннотации элемента, или наследованный или непосредственно существующий.
List<? extends Element>	getAllMembers(TypeElement type) Возвраты все элементы элемента типа, или наследованный или объявленный непосредственно.
Имя	getBinaryName(TypeElement type) Возвращает двоичное имя элемента типа.
Строка	getConstantExpression(Object value) Возвращает текст константного выражения, представляющего примитивное значение или строку.
Строка	getDocComment(Element e) Возвращает текст документации ("Javadoc") комментарий элемента.
Map<? extends ExecutableElement,? extends AnnotationValue>	getElementValuesWithDefaults(AnnotationMirror a) Возвращает значения элементов аннотации, включая значения по умолчанию.
Имя	getName(CharSequence cs) Возвратите имя с той же самой последовательностью символов как параметр.
PackageElement	getPackageElement(CharSequence name) Возвращает пакет, данный его полностью определенное имя.
PackageElement	getPackageOf(Element type) Возвращает пакет элемента.
TypeElement	getTypeElement(CharSequence name) Возвращает элемент типа, данный его каноническое имя.
boolean	hides(Element hider, Element hidden) Тесты, скрывают ли один тип, метод, или поле другого.
boolean	isDeprecated(Element e) Возвраты true если элемент осуждается, false иначе.
boolean	isFunctionalInterface(TypeElement type) Возвраты true если элемент типа является функциональным интерфейсом, false иначе.
boolean	overrides(ExecutableElement overrider, ExecutableElement overridden, TypeElement type) Тесты, переопределяет ли один метод, как элемент данного типа, другой метод.
void	printElements(Writer w, Element... elements) Печатает представление элементов данному писателю в указанном порядке.

Деталь метода

getPackageElement

PackageElement getPackageElement(CharSequence name)

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

Параметры:

name - полностью определенное имя пакета, или "" для неназванного пакета

Возвраты:

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

getTypeElement

TypeElement getTypeElement(CharSequence name)

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

Параметры:

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

Возвраты:

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

getElementValuesWithDefaults

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

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

Параметры:

a - аннотация, чтобы исследовать

Возвраты:

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

См. Также:

AnnotationMirror.getElementValues()

getDocComment

String getDocComment(Element e)

Возвращает текст документации ("Javadoc") комментарий элемента.

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

Параметры:

e - исследуемый элемент

Возвраты:

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

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

3.6 Пробел

isDeprecated

boolean isDeprecated(Element e)

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

Параметры:

e - исследуемый элемент

Возвраты:

true если элемент осуждается, false иначе

getBinaryName

Name getBinaryName(TypeElement type)

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

Параметры:

type - исследуемый элемент типа

Возвраты:

двоичное имя

См. Также:

TypeElement.getQualifiedName()

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

13.1 Форма Двоичного файла

getPackageOf

PackageElement getPackageOf(Element type)

Возвращает пакет элемента. Пакет пакета самостоятельно.

Параметры:

type - исследуемый элемент

Возвраты:

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

getAllMembers

List<? extends Element> getAllMembers(TypeElement type)

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

Отметьте, что элементы определенных видов могут быть изолированы, используя методы в ElementFilter.

Параметры:

type - исследуемый тип

Возвраты:

все элементы типа

См. Также:

Element.getEnclosedElements()

getAllAnnotationMirrors

List<? extends AnnotationMirror> getAllAnnotationMirrors(Element e)

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

Параметры:

e - исследуемый элемент

Возвраты:

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

См. Также:

Element.getAnnotationMirrors()

скрывается

boolean hides(Element hider,
              Element hidden)

Тесты, скрывают ли один тип, метод, или поле другого.

Параметры:

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

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

Возвраты:

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

переопределения

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

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

В самом простом и самом типичном использовании, значении type параметр просто будет class или соединит интерфейсом с непосредственно включением overrider (возможно переопределяющий метод). Например, предположить m1 представляет метод String.hashCode и m2 представляет Object.hashCode. Мы можем тогда спросить ли m1 переопределения m2 в пределах class 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"));

Параметры:

overrider - первый метод, возможный сверхнаездник

overridden - второй метод, возможно будучи переопределенным

type - типом которого первый метод является элементом

Возвраты:

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

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

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

getConstantExpression

String getConstantExpression(Object value)

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

Параметры:

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

Возвраты:

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

Броски:

IllegalArgumentException - если параметром не является примитивное значение или строка

См. Также:

VariableElement.getConstantValue()

printElements

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

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

Параметры:

w - писатель, чтобы напечатать вывод к

elements - элементы, чтобы напечатать

getName

Name getName(CharSequence cs)

Возвратите имя с той же самой последовательностью символов как параметр.

Параметры:

cs - символьная последовательность, чтобы возвратиться как имя

Возвраты:

имя с той же самой последовательностью символов как параметр

isFunctionalInterface

boolean isFunctionalInterface(TypeElement type)

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

Параметры:

type - исследуемый элемент типа

Возвраты:

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

С тех пор:

1.8

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

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