Interface AnnotationElement

public sealed interface AnnotationElement

AnnotationElement is a preview API of the Java platform.

Programs can only use AnnotationElement when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

Models an element-value pair in the element_value_pairs table in the annotation structure defined in JVMS 4.7.16 or the type_annotation structure defined in JVMS 4.7.20.

Two AnnotationElement objects should be compared using the equals method.

Since:

22

See Also:

• Annotation^PREVIEW
• AnnotationValue^PREVIEW

Method Summary

Modifier and Type	Method	Description
Utf8EntryPREVIEW	name()	Returns the element name.
static AnnotationElementPREVIEW	of(Utf8EntryPREVIEW name, AnnotationValuePREVIEW value)	Returns an element-value pair.
static AnnotationElementPREVIEW	of(String name, AnnotationValuePREVIEW value)	Returns an element-value pair.
static AnnotationElementPREVIEW	ofAnnotation(String name, AnnotationPREVIEW value)	Returns an element-value pair for an annotation-valued element.
static AnnotationElementPREVIEW	ofArray(String name, AnnotationValuePREVIEW... values)	Returns an element-value pair for an array-valued element.
static AnnotationElementPREVIEW	ofBoolean(String name, boolean value)	Returns an element-value pair for a boolean-valued element.
static AnnotationElementPREVIEW	ofByte(String name, byte value)	Returns an element-value pair for a byte-valued element.
static AnnotationElementPREVIEW	ofChar(String name, char value)	Returns an element-value pair for a char-valued element.
static AnnotationElementPREVIEW	ofClass(String name, ClassDesc value)	Returns an element-value pair for a class-valued element.
static AnnotationElementPREVIEW	ofDouble(String name, double value)	Returns an element-value pair for a double-valued element.
static AnnotationElementPREVIEW	ofFloat(String name, float value)	Returns an element-value pair for a float-valued element.
static AnnotationElementPREVIEW	ofInt(String name, int value)	Returns an element-value pair for an int-valued element.
static AnnotationElementPREVIEW	ofLong(String name, long value)	Returns an element-value pair for a long-valued element.
static AnnotationElementPREVIEW	ofShort(String name, short value)	Returns an element-value pair for a short-valued element.
static AnnotationElementPREVIEW	ofString(String name, String value)	Returns an element-value pair for a string-valued element.
AnnotationValuePREVIEW	value()	Returns the element value.

Method Details

name

Utf8EntryPREVIEW name()

Returns the element name.

API Note:

In Java source code, by convention, the name of the sole element in a single-element annotation interface is value. (JLS 9.6.1) This is the case for single-element annotations (JLS 9.7.3) and container annotations for multiple annotations (JLS 9.6.3).

Returns:

the element name

value

AnnotationValuePREVIEW value()

Returns the element value.

Returns:

the element value

of

static AnnotationElementPREVIEW of(Utf8EntryPREVIEW name,
 AnnotationValuePREVIEW value)

Returns an element-value pair.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair

of

static AnnotationElementPREVIEW of(String name,
 AnnotationValuePREVIEW value)

Returns an element-value pair.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair

ofClass

static AnnotationElementPREVIEW ofClass(String name,
 ClassDesc value)

Returns an element-value pair for a class-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a class-valued element

See Also:

• AnnotationValue::ofClass^PREVIEW

ofString

static AnnotationElementPREVIEW ofString(String name,
 String value)

Returns an element-value pair for a string-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a string-valued element

See Also:

• AnnotationValue::ofString^PREVIEW

ofLong

static AnnotationElementPREVIEW ofLong(String name,
 long value)

Returns an element-value pair for a long-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a long-valued element

See Also:

• AnnotationValue::ofLong^PREVIEW

ofInt

static AnnotationElementPREVIEW ofInt(String name,
 int value)

Returns an element-value pair for an int-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for an int-valued element

See Also:

• AnnotationValue::ofInt^PREVIEW

ofChar

static AnnotationElementPREVIEW ofChar(String name,
 char value)

Returns an element-value pair for a char-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a char-valued element

See Also:

• AnnotationValue::ofChar^PREVIEW

ofShort

static AnnotationElementPREVIEW ofShort(String name,
 short value)

Returns an element-value pair for a short-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a short-valued element

See Also:

• AnnotationValue::ofShort^PREVIEW

ofByte

static AnnotationElementPREVIEW ofByte(String name,
 byte value)

Returns an element-value pair for a byte-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a byte-valued element

See Also:

• AnnotationValue::ofByte^PREVIEW

ofBoolean

static AnnotationElementPREVIEW ofBoolean(String name,
 boolean value)

Returns an element-value pair for a boolean-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a boolean-valued element

See Also:

• AnnotationValue::ofBoolean^PREVIEW

ofDouble

static AnnotationElementPREVIEW ofDouble(String name,
 double value)

Returns an element-value pair for a double-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a double-valued element

See Also:

• AnnotationValue::ofDouble^PREVIEW

ofFloat

static AnnotationElementPREVIEW ofFloat(String name,
 float value)

Returns an element-value pair for a float-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for a float-valued element

See Also:

• AnnotationValue::ofFloat^PREVIEW

ofAnnotation

static AnnotationElementPREVIEW ofAnnotation(String name,
 AnnotationPREVIEW value)

Returns an element-value pair for an annotation-valued element.

Parameters:

name - the name of the key

value - the associated value

Returns:

an element-value pair for an annotation-valued element

See Also:

• AnnotationValue::ofAnnotation^PREVIEW

ofArray

static AnnotationElementPREVIEW ofArray(String name,
 AnnotationValuePREVIEW... values)

Returns an element-value pair for an array-valued element.

Parameters:

name - the name of the key

values - the associated values

Returns:

an element-value pair for an array-valued element

See Also:

• AnnotationValue::ofArray^PREVIEW