Package Summary  Overview Summary

class:ElementType [CHANGED]

All Implemented Interfaces:
Serializable, Comparable<ElementType>, Constable

public enum ElementType
extends Enum<ElementType>
The constants of this enumerated type 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 type 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: type declarations (including annotation type declarations) and type parameter declarations.

For example, an annotation whose type is meta-annotated with @Target(ElementType.TYPE_USE) may be written on the type of a field (or within the type of the field, if it is a nested, parameterized, or array type), and may also appear as a modifier for, say, a class declaration.

The TYPE_USE constant includes type declarations and type parameter declarations as a convenience for designers of type checkers which give semantics to annotation types. For example, if the annotation type NonNull is meta-annotated with @Target(ElementType.TYPE_USE), then @NonNullclass 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.

See Java Language Specification :
9.6.4.1 @Target

4.1 The Kinds of Types and Values

Since:
1.5
All Implemented Interfaces:
Serializable, Comparable<ElementType>, Constable

public enum ElementType
extends Enum<ElementType>
The constants of this enumerated type 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 type 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: type declarations (including annotation type declarations) and type parameter declarations.

For example, an annotation whose type is meta-annotated with @Target(ElementType.TYPE_USE) may be written on the type of a field (or within the type of the field, if it is a nested, parameterized, or array type), and may also appear as a modifier for, say, a class declaration.

The TYPE_USE constant includes type declarations and type parameter declarations as a convenience for designers of type checkers which give semantics to annotation types. For example, if the annotation type NonNull is meta-annotated with @Target(ElementType.TYPE_USE), then @NonNullclass 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.

See Java Language Specification :
9.6.4.1 @Target
4.1 The Kinds of Types and Values
Since:
1.5
All Implemented Interfaces:
Serializable, Comparable<ElementType>, Constable

public enum ElementType
extends Enum<ElementType>
The constants of this enumerated type 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 type 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: type declarations (including annotation type declarations) and type parameter declarations.

For example, an annotation whose type is meta-annotated with @Target(ElementType.TYPE_USE) may be written on the type of a field (or within the type of the field, if it is a nested, parameterized, or array type), and may also appear as a modifier for, say, a class declaration.

The TYPE_USE constant includes type declarations and type parameter declarations as a convenience for designers of type checkers which give semantics to annotation types. For example, if the annotation type NonNull is meta-annotated with @Target(ElementType.TYPE_USE), then @NonNullclass 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.

Since:
1.5

field:TYPE [NONE]

  • TYPE

    public static final  ElementType TYPE
    Class, interface (including annotation type), enum, or record declaration
  • field:FIELD [NONE]

    FIELD

    public static final  ElementType FIELD
    Field declaration (includes enum constants)

    field:METHOD [NONE]

    METHOD

    public static final  ElementType METHOD
    Method declaration

    field:PARAMETER [NONE]

    PARAMETER

    public static final  ElementType PARAMETER
    Formal parameter declaration

    field:CONSTRUCTOR [NONE]

    CONSTRUCTOR

    public static final  ElementType CONSTRUCTOR
    Constructor declaration

    field:LOCAL_VARIABLE [NONE]

    LOCAL_VARIABLE

    public static final  ElementType LOCAL_VARIABLE
    Local variable declaration

    field:ANNOTATION_TYPE [NONE]

    ANNOTATION_TYPE

    public static final  ElementType ANNOTATION_TYPE
    Annotation type declaration

    field:PACKAGE [NONE]

    PACKAGE

    public static final  ElementType PACKAGE
    Package declaration

    field:TYPE_PARAMETER [NONE]

    TYPE_PARAMETER

    public static final  ElementType TYPE_PARAMETER
    Type parameter declaration
    Since:
    1.8

    field:TYPE_USE [NONE]

    TYPE_USE

    public static final  ElementType TYPE_USE
    Use of a type
    Since:
    1.8

    field:MODULE [NONE]

    MODULE

    public static final  ElementType MODULE
    Module declaration.
    Since:
    9

    field:RECORD_COMPONENT [CHANGED]

    RECORD_COMPONENT

    public static final  ElementType RECORD_COMPONENT
    This constant is associated with records, a preview feature of the Java language. Programs can only use this constant when preview features are enabled. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.

    Record component
    See Java Language Specification :
    8.10.3 Record Members

    9.7.4 Where Annotations May Appear

    Since:
    14

    RECORD_COMPONENT

    public static final  ElementType RECORD_COMPONENT
    This constant is associated with records, a preview feature of the Java language. Programs can only use this constant when preview features are enabled. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.

    Record component
    See Java Language Specification :
    8.10.3 Record Members
    9.7.4 Where Annotations May Appear
    Since:
    14

    RECORD_COMPONENT

    public static final  ElementType RECORD_COMPONENT
    This constant is associated with records, a preview feature of the Java language. Programs can only use this constant when preview features are enabled. Preview features may be removed in a future release, or upgraded to permanent features of the Java language.

    Record component
    Since:
    14

    method:values() [NONE]

  • values

    public static  ElementType[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  • method:valueOf(java.lang.String) [NONE]

    valueOf

    public static  ElementType valueOf?(String name)
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    Parameters:
    name - the name of the enum constant to be returned.
    Returns:
    the enum constant with the specified name
    Throws:
    IllegalArgumentException - if this enum type has no constant with the specified name
    NullPointerException - if the argument is null

    © 2020 Oracle Corporation and/or its affiliates