Интерфейс AnnotatedType

Все суперинтерфейсы:: AnnotatedElement

Все известные подинтерфейсы:: AnnotatedArrayType, AnnotatedParameterizedType, AnnotatedTypeVariable, AnnotatedWildcardType

public interface AnnotatedType extends AnnotatedElement

AnnotatedType представляет потенциально аннотированное использование типа в программе, выполняющейся в данный момент в этой виртуальной машине. Использование может относиться к любому типу языка программирования Java, включая тип массива, параметризованный тип, переменную типа или тип подстановочного знака. Обратите внимание, что любые аннотации, возвращаемые методами этого интерфейса, являются аннотациями типов (JLS §9.7.4), поскольку потенциально аннотируемая сущность является типом.

См. Спецификацию языка Java:: 4.1 Виды типов и значений
4.2 Примитивные типы и значения
4.3 Ссылочные типы и значения
4.4 Переменные типов
4.5 Параметризованные типы
4.8 Сырые типы
4.9 Типы-пересечения
10.1 Типы массивов
С версии:: 1.8

Краткое описание методов

Модификатор и тип	Метод	Описание
`default AnnotatedType`	`getAnnotatedOwnerType()`	Возвращает потенциально аннотированный тип, членом которого является этот тип, если этот тип представляет вложенный тип.
`<T extends Annotation> T`	`getAnnotation(Class<T> annotationClass)`	Возвращает аннотацию этого элемента для указанного типа, если такая аннотация присутствует, иначе возвращает null.
`Annotation[]`	`getAnnotations()`	Возвращает аннотации, присутствующие в этом элементе.
`Annotation[]`	`getDeclaredAnnotations()`	Возвращает аннотации, непосредственно присутствующие в этом элементе.
`Type`	`getType()`	Возвращает базовый тип, который представляет этот аннотированный тип.

Методы, объявленные в интерфейсе AnnotatedElement

getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAnnotationPresent

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

Подробное описание методов

getAnnotatedOwnerType

default AnnotatedType getAnnotatedOwnerType()

Возвращает потенциально аннотированный тип, членом которого является этот тип, если этот тип представляет вложенный тип. Например, если этот тип — @TA O<T>.I<S>, возвращает представление @TA O<T>.

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

Возвращает null, если этот AnnotatedType является экземпляром AnnotatedArrayType, AnnotatedTypeVariable или AnnotatedWildcardType.

Требования к реализации:: Эта реализация по умолчанию возвращает null и не выполняет никаких других действий.
Возвращает:: объект AnnotatedType, представляющий потенциально аннотированный тип, членом которого является этот тип, или null
Исключения:: TypeNotPresentException — если тип-владелец ссылается на несуществующее объявление класса или интерфейса; MalformedParameterizedTypeException — если тип-владелец ссылается на параметризованный тип, который по какой-либо причине невозможно инстанцировать
С версии:: 9

getType

Type getType()

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

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

getAnnotation

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

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

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

Определено в:: getAnnotation в интерфейсе AnnotatedElement
Параметры типа:: T — тип аннотации, которую нужно запросить и вернуть, если она присутствует
Параметры:: annotationClass — объект Class, соответствующий типу аннотации
Возвращает:: аннотацию этого элемента для указанного типа аннотации, если она присутствует в этом элементе, иначе null
Исключения:: NullPointerException — если указанный класс аннотации равен null

getAnnotations

Annotation[] getAnnotations()

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

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

Определено в:: getAnnotations в интерфейсе AnnotatedElement
Возвращает:: аннотации, присутствующие в этом элементе

getDeclaredAnnotations

Annotation[] getDeclaredAnnotations()

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

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

Определено в:: getDeclaredAnnotations в интерфейсе AnnotatedElement
Возвращает:: аннотации, непосредственно присутствующие в этом элементе

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.