APIdia Launch Partner
Top Description Fields Constructors Methods
java.lang.annotation

public final Enum ElementType

extends Enum<ElementType>
Class Inheritance

The constants of this enumerated class provide a simple classification of the syntactic locations where annotations may appear in a Java program. These constants are used in 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.

Author
Joshua Bloch
Since
1.5
Java Language Specification
9.6.4.1 @Target, 4.1 The Kinds of Types and Values

Field Summary

Modifier and TypeField and Description
public static final ElementType
ANNOTATION_TYPE

Annotation interface declaration (Formerly known as an annotation type.)

public static final ElementType
CONSTRUCTOR

Constructor declaration

public static final ElementType
FIELD

Field declaration (includes enum constants)

public static final ElementType
LOCAL_VARIABLE

Local variable declaration

public static final ElementType
METHOD

Method declaration

public static final ElementType
MODULE

Module declaration.

public static final ElementType
PACKAGE

Package declaration

public static final ElementType
PARAMETER

Formal parameter declaration

public static final ElementType
RECORD_COMPONENT

Record component

public static final ElementType
TYPE

Class, interface (including annotation interface), enum, or record declaration

public static final ElementType
TYPE_PARAMETER

Type parameter declaration

public static final ElementType
TYPE_USE

Use of a type

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ElementType
public static ElementType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ANNOTATION_TYPEback to summary
public static final ElementType ANNOTATION_TYPE

Annotation interface declaration (Formerly known as an annotation type.)

CONSTRUCTORback to summary
public static final ElementType CONSTRUCTOR

Constructor declaration

FIELDback to summary
public static final ElementType FIELD

Field declaration (includes enum constants)

LOCAL_VARIABLEback to summary
public static final ElementType LOCAL_VARIABLE

Local variable declaration

METHODback to summary
public static final ElementType METHOD

Method declaration

MODULEback to summary
public static final ElementType MODULE

Module declaration.

Since
9
PACKAGEback to summary
public static final ElementType PACKAGE

Package declaration

PARAMETERback to summary
public static final ElementType PARAMETER

Formal parameter declaration

RECORD_COMPONENTback to summary
public static final ElementType RECORD_COMPONENT

Record component

Since
16
Java Language Specification
8.10.3 Record Members, 9.7.4 Where Annotations May Appear
TYPEback to summary
public static final ElementType TYPE

Class, interface (including annotation interface), enum, or record declaration

TYPE_PARAMETERback to summary
public static final ElementType TYPE_PARAMETER

Type parameter declaration

Since
1.8
TYPE_USEback to summary
public static final ElementType TYPE_USE

Use of a type

Since
1.8

Constructor Detail

ElementTypeback to summary
private ElementType()

Method Detail

valueOfback to summary
public static ElementType valueOf(String name)
valuesback to summary
public static ElementType[] values()