compact1, compact2, compact3

java.lang.reflect

Интерфейс AnnotatedElement

Все Известные Подынтерфейсы:

AnnotatedArrayType, AnnotatedParameterizedType, AnnotatedType, AnnotatedTypeVariable, AnnotatedWildcardType, TypeVariable <D>

Все Известные Классы с реализацией:

AccessibleObject, Класс, Конструктор, Исполнимая программа, Поле, Метод, Пакет, Параметр

public interface AnnotatedElement

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

getAnnotationsByType(Class) и getDeclaredAnnotationsByType(Class) методы поддерживают многократные аннотации того же самого типа на элементе. Если параметром любому методу будет повторимый тип аннотации (JLS 9.6), то метод "просмотрит" контейнерную аннотацию (JLS 9.7), который был сгенерирован во время компиляции, чтобы обернуть многократные аннотации типа параметра.

Термины, непосредственно существующие и существующие, используются всюду по этому интерфейсу, чтобы описать точно, какие аннотации возвращаются методами:

• Аннотация A непосредственно присутствует на элементе E, если E связывается с атрибутом RuntimeVisibleAnnotations или RuntimeVisibleParameterAnnotations, и:
  • для вызова get[Declared]Annotation(Class<T>) или get[Declared]Annotations(), атрибут содержит A.
  • для вызова get[Declared]AnnotationsByType(Class<T>), атрибут или содержит A или, если тип A повторим, содержит точно одну аннотацию, элемент значения которой содержит A и чей тип является содержанием типа аннотации типа А (JLS 9.6).

• Аннотация A присутствует на элементе E если также:
  • A непосредственно присутствует на E; или
  • A непосредственно не присутствует на E, и E является class, и тип А является наследуемым (JLS 9.6.3.3), и A присутствует на суперклассе E.

Если аннотация, возвращенная методом в этом интерфейсе, содержит (прямо или косвенно) a Class- оцененный элемент, обращающийся к class, который не доступен в этом VM, пытаясь считать class, вызывая соответствующий метод Class-returning на возвращенной аннотации, приведет к a TypeNotPresentException.

Точно так же попытка считать оцененный перечислению элемент приведет к a EnumConstantNotPresentException если перечислимая константа в аннотации больше не присутствует в перечислимом типе.

Попытка считать аннотации повторимого типа T аннотации, которые содержатся в аннотации, тип которой не является, фактически, содержанием типа аннотации T, приведет к AnnotationFormatError.

Наконец, попытка считать элемент, определение которого развилось несовместимо, приведет к a AnnotationTypeMismatchException или IncompleteAnnotationException.

С тех пор:

1.5

См. Также:

EnumConstantNotPresentException, TypeNotPresentException, AnnotationFormatError, AnnotationTypeMismatchException, IncompleteAnnotationException

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

Модификатор и Тип	Метод и Описание
<T extends Annotation> T	getAnnotation(Class<T> annotationClass) Возвраты аннотация этого элемента для указанного типа, если такая аннотация присутствует, еще нуль.
Аннотация[]	getAnnotations() Аннотации возвратов, которые присутствуют на этом элементе.
<T extends Annotation> T[]	getAnnotationsByType(Class<T> annotationClass) Аннотации возвратов, которые присутствуют на этом элементе.
<T extends Annotation> T	getDeclaredAnnotation(Class<T> annotationClass) Возвраты аннотация этого элемента для указанного типа, если такая аннотация присутствует, еще нуль.
Аннотация[]	getDeclaredAnnotations() Аннотации возвратов, которые непосредственно присутствуют на этом элементе.
<T extends Annotation> T[]	getDeclaredAnnotationsByType(Class<T> annotationClass) Аннотации возвратов, которые непосредственно присутствуют на этом элементе.
default boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass) Возвращает true, если аннотация для указанного типа присутствует на этом элементе, еще ложь.

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

isAnnotationPresent

default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

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

Значение истинности, возвращенное этим методом, эквивалентно: getAnnotation(annotationClass) != null

Тело метода значения по умолчанию определяется, чтобы быть кодом выше.

Параметры:

annotationClass - соответствие объекта Класса типу аннотации

Возвраты:

истина, если аннотация для указанного типа аннотации присутствует на этом элементе, еще ложь

Броски:

NullPointerException - если данная аннотация class является нулем

С тех пор:

1.5

getAnnotation

<T extends Annotation> T getAnnotation(Class<T> annotationClass)

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

Параметры:

annotationClass - соответствие объекта Класса типу аннотации

Возвраты:

аннотация этого элемента для указанной аннотации вводит если существующий на этом элементе, еще нуль

Броски:

NullPointerException - если данная аннотация class является нулем

С тех пор:

1.5

getAnnotationsByType

<T extends Annotation> T[] getAnnotationsByType(Class<T> annotationClass)

Аннотации возвратов, которые присутствуют на этом элементе. Если нет никакого подарка аннотаций на этом элементе, возвращаемое значение является массивом длины 0. Различие между этим методом и getAnnotation(Class) тот этот метод, обнаруживает, если его параметр является повторимым типом аннотации (JLS 9.6), и если так, пытается найти одну или более аннотаций того типа, "просматривая" контейнерную аннотацию. Вызывающая сторона этого метода свободна изменить возвращенный массив; это не будет иметь никакого эффекта на массивы, возвращенные к другим вызывающим сторонам.

Параметры:

annotationClass - соответствие объекта Класса типу аннотации

Возвраты:

аннотации всего этого элемента для указанной аннотации вводят если существующий на этом элементе, еще массив нуля длины

Броски:

NullPointerException - если данная аннотация class является нулем

С тех пор:

1.8

getAnnotations

Annotation[] getAnnotations()

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

Возвраты:

аннотации представляют на этом элементе

С тех пор:

1.5

getDeclaredAnnotation

<T extends Annotation> T getDeclaredAnnotation(Class<T> annotationClass)

Возвраты аннотация этого элемента для указанного типа, если такая аннотация присутствует, еще нуль. Этот метод игнорирует наследованные аннотации. (Нуль возвратов, если никакие аннотации непосредственно не присутствуют на этом элементе.)

Параметры:

annotationClass - соответствие объекта Класса типу аннотации

Возвраты:

аннотация этого элемента для указанной аннотации вводит если существующий на этом элементе, еще нуль

Броски:

NullPointerException - если данная аннотация class является нулем

С тех пор:

1.8

getDeclaredAnnotationsByType

<T extends Annotation> T[] getDeclaredAnnotationsByType(Class<T> annotationClass)

Аннотации возвратов, которые непосредственно присутствуют на этом элементе. Этот метод игнорирует наследованные аннотации. Если нет никаких аннотаций, непосредственно существующих на этом элементе, возвращаемое значение является массивом длины 0. Различие между этим методом и getDeclaredAnnotation(Class) тот этот метод, обнаруживает, если его параметр является повторимым типом аннотации (JLS 9.6), и если так, пытается найти одну или более аннотаций того типа, "просматривая" контейнерную аннотацию. Вызывающая сторона этого метода свободна изменить возвращенный массив; это не будет иметь никакого эффекта на массивы, возвращенные к другим вызывающим сторонам.

Параметры:

annotationClass - соответствие объекта Класса типу аннотации

Возвраты:

аннотации всего этого элемента для указанной аннотации вводят если существующий на этом элементе, еще массив нуля длины

Броски:

NullPointerException - если данная аннотация class является нулем

С тех пор:

1.8

getDeclaredAnnotations

Annotation[] getDeclaredAnnotations()

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

Возвраты:

аннотации, непосредственно существующие на этом элементе

С тех пор:

1.5