Serializable
, Comparable<ElementType>
, Constable
public enum ElementType extends Enum<ElementType>
Target
meta-annotations to specify where it is legal to write annotations of a given type. The syntactic locations where annotations may appear are split into declaration contexts, where annotations apply to declarations, and type contexts, where annotations apply to types used in declarations and expressions.
The constants ANNOTATION_TYPE
, CONSTRUCTOR
, FIELD
, LOCAL_VARIABLE
, METHOD
, PACKAGE
, MODULE
, PARAMETER
, TYPE
, and TYPE_PARAMETER
correspond to the declaration contexts in JLS 9.6.4.1.
For example, an annotation whose interface is meta-annotated with @Target(ElementType.FIELD)
may only be written as a modifier for a field declaration.
The constant TYPE_USE
corresponds to the type contexts in JLS 4.11, as well as to two declaration contexts: class and interface declarations (including annotation declarations) and type parameter declarations.
For example, an annotation whose interface is meta-annotated with @Target(ElementType.TYPE_USE)
may be written on the class or interface of a field (or within the class or interface of the field, if it is a nested or parameterized class or interface, or array class), and may also appear as a modifier for, say, a class declaration.
The TYPE_USE
constant includes class and interface declarations and type parameter declarations as a convenience for designers of type checkers which give semantics to annotation interfaces. For example, if the annotation interface NonNull
is meta-annotated with @Target(ElementType.TYPE_USE)
, then @NonNull
class C {...}
could be treated by a type checker as indicating that all variables of class C
are non-null, while still allowing variables of other classes to be non-null or not non-null based on whether @NonNull
appears at the variable's declaration.
Enum.EnumDesc<E extends Enum<E>>
Enum Constant | Description |
---|---|
ANNOTATION_TYPE |
Annotation interface declaration (Formerly known as an annotation type.) |
CONSTRUCTOR |
Constructor declaration |
FIELD |
Field declaration (includes enum constants) |
LOCAL_VARIABLE |
Local variable declaration |
METHOD |
Method declaration |
MODULE |
Module declaration. |
PACKAGE |
Package declaration |
PARAMETER |
Formal parameter declaration |
RECORD_COMPONENT |
Record component |
TYPE |
Class, interface (including annotation interface), enum, or record declaration |
TYPE_PARAMETER |
Type parameter declaration |
TYPE_USE |
Use of a type |
Modifier and Type | Method | Description |
---|---|---|
static ElementType |
valueOf |
Returns the enum constant of this class with the specified name. |
static ElementType[] |
values() |
Returns an array containing the constants of this enum class, in the order they are declared. |
public static final ElementType TYPE
public static final ElementType FIELD
public static final ElementType METHOD
public static final ElementType PARAMETER
public static final ElementType CONSTRUCTOR
public static final ElementType LOCAL_VARIABLE
public static final ElementType ANNOTATION_TYPE
public static final ElementType PACKAGE
public static final ElementType TYPE_PARAMETER
public static final ElementType TYPE_USE
public static final ElementType MODULE
public static final ElementType RECORD_COMPONENT
public static ElementType[] values()
public static ElementType valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is 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