Serializable
, Comparable<ElementType>
, Constable
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.
Enum Constants
Annotation interface declaration (Formerly known as an annotation type.)
Field declaration (includes enum constants)
Local variable declaration
Formal parameter declaration
Class, interface (including annotation interface), enum, or record declaration
Type parameter declaration
Returns the enum constant of this class with the specified name.
Returns an array containing the constants of this enum class, in the order they are declared.
Methods declared in class java.lang.Enumclone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Class, interface (including annotation interface), enum, or record declaration
Field declaration (includes enum constants)
Method declaration
Formal parameter declaration
Constructor declaration
Local variable declaration
Annotation interface declaration (Formerly known as an annotation type.)
Package declaration
Type parameter declaration
Use of a type
Module declaration.
Record component
Returns an array containing the constants of this enum class, in the order they are declared.
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
name
- the name of the enum constant to be returned.
IllegalArgumentException
- if this enum class has no constant with the specified name
NullPointerException
- if the argument is null
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4