Spec-Zone.ru › OpenJDK 21

Класс перечисления ElementType

java.lang.Object
java.lang.Enum<ElementType>
java.lang.annotation.ElementType
Все реализуемые интерфейсы:
Serializable, Comparable<ElementType>, Constable
public enum ElementType extends Enum<ElementType>
Константы этого класса перечисления обеспечивают простую классификацию синтаксических позиций, в которых могут встречаться аннотации в программе Java. Эти константы используются в мета-аннотациях Target, чтобы указать, где разрешено записывать аннотации заданного типа.

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

Константы ANNOTATION_TYPE, CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE и TYPE_PARAMETER соответствуют контекстам объявлений, указанным в JLS 9.6.4.1.

Например, аннотацию, интерфейс которой помечен мета-аннотацией @Target(ElementType.FIELD), можно записывать только как модификатор объявления поля.

Константа TYPE_USE соответствует контекстам типов, указанным в JLS 4.11, а также двум контекстам объявлений: объявлениям классов и интерфейсов (включая объявления аннотаций) и объявлениям параметров типа.

Например, аннотацию, интерфейс которой помечен мета-аннотацией @Target(ElementType.TYPE_USE), можно записывать для класса или интерфейса поля (или внутри класса или интерфейса поля, если это вложенный класс или интерфейс, параметризованный класс или интерфейс либо класс массива), а также использовать как модификатор, например, объявления класса.

Константа TYPE_USE включает объявления классов и интерфейсов, а также объявления параметров типа, что удобно для разработчиков средств проверки типов, которые задают семантику интерфейсам аннотаций. Например, если интерфейс аннотации NonNull помечен мета-аннотацией @Target(ElementType.TYPE_USE), то @NonNull class C {...} средство проверки типов может трактовать как указание на то, что все переменные класса C не равны null, при этом переменные других классов могут быть или не быть равными null в зависимости от того, указана ли @NonNull в объявлении переменной.

См. Спецификацию языка Java:
9.6.4.1 @Target
4.1 Виды типов и значений
Начиная с:
1.5

Краткое описание вложенных классов

Вложенные классы/интерфейсы, объявленные в классе java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Краткое описание констант перечисления

Константа перечисления Описание
ANNOTATION_TYPE
Объявление интерфейса аннотации (ранее назывался типом аннотации)
CONSTRUCTOR
Объявление конструктора
FIELD
Объявление поля (включая константы перечисления)
LOCAL_VARIABLE
Объявление локальной переменной
METHOD
Объявление метода
MODULE
Объявление модуля.
PACKAGE
Объявление пакета
PARAMETER
Объявление формального параметра
RECORD_COMPONENT
Компонент записи
TYPE
Объявление класса, интерфейса (включая интерфейс аннотации), перечисления или записи
TYPE_PARAMETER
Объявление параметра типа
TYPE_USE
Использование типа

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

Модификатор и тип Метод Описание
static ElementType valueOf(String name)
Возвращает константу перечисления этого класса с указанным именем.
static ElementType[] values()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

Методы, объявленные в классе java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Методы, объявленные в классе java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Подробное описание констант перечисления

TYPE

public static final ElementType TYPE
Объявление класса, интерфейса (включая интерфейс аннотации), перечисления или записи

FIELD

public static final ElementType FIELD
Объявление поля (включая константы перечисления)

METHOD

public static final ElementType METHOD
Объявление метода

PARAMETER

public static final ElementType PARAMETER
Объявление формального параметра

CONSTRUCTOR

public static final ElementType CONSTRUCTOR
Объявление конструктора

LOCAL_VARIABLE

public static final ElementType LOCAL_VARIABLE
Объявление локальной переменной

ANNOTATION_TYPE

public static final ElementType ANNOTATION_TYPE
Объявление интерфейса аннотации (ранее называвшегося типом аннотации)

PACKAGE

public static final ElementType PACKAGE
Объявление пакета

TYPE_PARAMETER

public static final ElementType TYPE_PARAMETER
Объявление параметра типа
Начиная с:
1.8

TYPE_USE

public static final ElementType TYPE_USE
Использование типа
Начиная с:
1.8

MODULE

public static final ElementType MODULE
Объявление модуля.
Начиная с:
9

RECORD_COMPONENT

public static final ElementType RECORD_COMPONENT
Компонент записи
См. Спецификацию языка Java:
8.10.3 Элементы записи
9.7.4 Где могут встречаться аннотации
Начиная с:
16

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

values

public static ElementType[] values()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.
Возвращает:
массив, содержащий константы этого класса перечисления в порядке их объявления

valueOf

public static ElementType valueOf(String name)
Возвращает константу перечисления этого класса с указанным именем. Строка должна точно совпадать с идентификатором, использованным для объявления константы перечисления в этом классе. (Лишние пробельные символы не допускаются.)
Параметры:
name — имя константы перечисления, которую нужно вернуть.
Возвращает:
константу перечисления с указанным именем
Выбрасывает:
IllegalArgumentException — если в этом классе перечисления нет константы с указанным именем
NullPointerException — если аргумент равен null

© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/annotation/ElementType.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API