Interface AnnotationValue

All Known Subinterfaces:

AnnotationValue.OfAnnotationPREVIEW, AnnotationValue.OfArrayPREVIEW, AnnotationValue.OfBooleanPREVIEW, AnnotationValue.OfBytePREVIEW, AnnotationValue.OfCharPREVIEW, AnnotationValue.OfClassPREVIEW, AnnotationValue.OfConstantPREVIEW, AnnotationValue.OfDoublePREVIEW, AnnotationValue.OfEnumPREVIEW, AnnotationValue.OfFloatPREVIEW, AnnotationValue.OfIntPREVIEW, AnnotationValue.OfLongPREVIEW, AnnotationValue.OfShortPREVIEW, AnnotationValue.OfStringPREVIEW

public sealed interface AnnotationValue
permits AnnotationValue.OfAnnotationPREVIEW, AnnotationValue.OfArrayPREVIEW, AnnotationValue.OfConstantPREVIEW, AnnotationValue.OfClassPREVIEW, AnnotationValue.OfEnumPREVIEW

AnnotationValue is a preview API of the Java platform.

Programs can only use AnnotationValue 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 structure, or a value of an element-value pair of an annotation, as defined in JVMS 4.7.16.1.

Two AnnotationValue objects should be compared using the equals method.

Sealed Class Hierarchy Graph:

Since:

22

See Also:

• Annotation^PREVIEW
• AnnotationElement^PREVIEW

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AnnotationValue.OfAnnotationPREVIEW	Preview. Models an annotation value of an element-value pair.
static interface	AnnotationValue.OfArrayPREVIEW	Preview. Models an array value of an element-value pair.
static interface	AnnotationValue.OfBooleanPREVIEW	Preview. Models a boolean value of an element-value pair.
static interface	AnnotationValue.OfBytePREVIEW	Preview. Models a byte value of an element-value pair.
static interface	AnnotationValue.OfCharPREVIEW	Preview. Models a char value of an element-value pair.
static interface	AnnotationValue.OfClassPREVIEW	Preview. Models a class value of an element-value pair.
static interface	AnnotationValue.OfConstantPREVIEW	Preview. Models a constant value of an element-value pair.
static interface	AnnotationValue.OfDoublePREVIEW	Preview. Models a double value of an element-value pair.
static interface	AnnotationValue.OfEnumPREVIEW	Preview. Models an enum value of an element-value pair.
static interface	AnnotationValue.OfFloatPREVIEW	Preview. Models a float value of an element-value pair.
static interface	AnnotationValue.OfIntPREVIEW	Preview. Models an int value of an element-value pair.
static interface	AnnotationValue.OfLongPREVIEW	Preview. Models a long value of an element-value pair.
static interface	AnnotationValue.OfShortPREVIEW	Preview. Models a short value of an element-value pair.
static interface	AnnotationValue.OfStringPREVIEW	Preview. Models a string value of an element-value pair.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG_ANNOTATION	The tag indicating the value of an element-value pair is AnnotationValue.OfAnnotationPREVIEW.
static final int	TAG_ARRAY	The tag indicating the value of an element-value pair is AnnotationValue.OfArrayPREVIEW.
static final int	TAG_BOOLEAN	The tag indicating the value of an element-value pair is AnnotationValue.OfBooleanPREVIEW.
static final int	TAG_BYTE	The tag indicating the value of an element-value pair is AnnotationValue.OfBytePREVIEW.
static final int	TAG_CHAR	The tag indicating the value of an element-value pair is AnnotationValue.OfCharPREVIEW.
static final int	TAG_CLASS	The tag indicating the value of an element-value pair is AnnotationValue.OfClassPREVIEW.
static final int	TAG_DOUBLE	The tag indicating the value of an element-value pair is AnnotationValue.OfDoublePREVIEW.
static final int	TAG_ENUM	The tag indicating the value of an element-value pair is AnnotationValue.OfEnumPREVIEW.
static final int	TAG_FLOAT	The tag indicating the value of an element-value pair is AnnotationValue.OfFloatPREVIEW.
static final int	TAG_INT	The tag indicating the value of an element-value pair is AnnotationValue.OfIntPREVIEW.
static final int	TAG_LONG	The tag indicating the value of an element-value pair is AnnotationValue.OfLongPREVIEW.
static final int	TAG_SHORT	The tag indicating the value of an element-value pair is AnnotationValue.OfShortPREVIEW.
static final int	TAG_STRING	The tag indicating the value of an element-value pair is AnnotationValue.OfStringPREVIEW.

Method Summary

Modifier and Type	Method	Description
static AnnotationValuePREVIEW	of(Object value)	Returns an annotation element.
static AnnotationValue.OfAnnotationPREVIEW	ofAnnotation(AnnotationPREVIEW value)	Returns an annotation value for an element-value pair.
static AnnotationValue.OfArrayPREVIEW	ofArray(AnnotationValuePREVIEW... values)	Returns an array value for an element-value pair.
static AnnotationValue.OfArrayPREVIEW	ofArray(List<AnnotationValuePREVIEW> values)	Returns an array value for an element-value pair.
static AnnotationValue.OfBooleanPREVIEW	ofBoolean(boolean value)	Returns a boolean value for an element-value pair.
static AnnotationValue.OfBooleanPREVIEW	ofBoolean(IntegerEntryPREVIEW value)	Returns a boolean value for an element-value pair.
static AnnotationValue.OfBytePREVIEW	ofByte(byte value)	Returns a byte value for an element-value pair.
static AnnotationValue.OfBytePREVIEW	ofByte(IntegerEntryPREVIEW value)	Returns a byte value for an element-value pair.
static AnnotationValue.OfCharPREVIEW	ofChar(char value)	Returns a char value for an element-value pair.
static AnnotationValue.OfCharPREVIEW	ofChar(IntegerEntryPREVIEW value)	Returns a char value for an element-value pair.
static AnnotationValue.OfClassPREVIEW	ofClass(Utf8EntryPREVIEW className)	Returns a class value for an element-value pair.
static AnnotationValue.OfClassPREVIEW	ofClass(ClassDesc className)	Returns a class value for an element-value pair.
static AnnotationValue.OfDoublePREVIEW	ofDouble(double value)	Returns a double value for an element-value pair.
static AnnotationValue.OfDoublePREVIEW	ofDouble(DoubleEntryPREVIEW value)	Returns a double value for an element-value pair.
static AnnotationValue.OfEnumPREVIEW	ofEnum(Utf8EntryPREVIEW className, Utf8EntryPREVIEW constantName)	Returns an enum value for an element-value pair.
static AnnotationValue.OfEnumPREVIEW	ofEnum(ClassDesc className, String constantName)	Returns an enum value for an element-value pair.
static AnnotationValue.OfFloatPREVIEW	ofFloat(float value)	Returns a float value for an element-value pair.
static AnnotationValue.OfFloatPREVIEW	ofFloat(FloatEntryPREVIEW value)	Returns a float value for an element-value pair.
static AnnotationValue.OfIntPREVIEW	ofInt(int value)	Returns an int value for an element-value pair.
static AnnotationValue.OfIntPREVIEW	ofInt(IntegerEntryPREVIEW value)	Returns an int value for an element-value pair.
static AnnotationValue.OfLongPREVIEW	ofLong(long value)	Returns a long value for an element-value pair.
static AnnotationValue.OfLongPREVIEW	ofLong(LongEntryPREVIEW value)	Returns a long value for an element-value pair.
static AnnotationValue.OfShortPREVIEW	ofShort(short value)	Returns a short value for an element-value pair.
static AnnotationValue.OfShortPREVIEW	ofShort(IntegerEntryPREVIEW value)	Returns a short value for an element-value pair.
static AnnotationValue.OfStringPREVIEW	ofString(Utf8EntryPREVIEW value)	Returns a string value for an element-value pair.
static AnnotationValue.OfStringPREVIEW	ofString(String value)	Returns a string value for an element-value pair.
char	tag()	Returns the tag character for this value as per JVMS 4.7.16.1.

Field Details

TAG_BYTE

static final int TAG_BYTE

The tag indicating the value of an element-value pair is AnnotationValue.OfByte^PREVIEW.

See Also:

• Constant Field Values

TAG_CHAR

static final int TAG_CHAR

The tag indicating the value of an element-value pair is AnnotationValue.OfChar^PREVIEW.

See Also:

• Constant Field Values

TAG_DOUBLE

static final int TAG_DOUBLE

The tag indicating the value of an element-value pair is AnnotationValue.OfDouble^PREVIEW.

See Also:

• Constant Field Values

TAG_FLOAT

static final int TAG_FLOAT

The tag indicating the value of an element-value pair is AnnotationValue.OfFloat^PREVIEW.

See Also:

• Constant Field Values

TAG_INT

static final int TAG_INT

The tag indicating the value of an element-value pair is AnnotationValue.OfInt^PREVIEW.

See Also:

• Constant Field Values

TAG_LONG

static final int TAG_LONG

The tag indicating the value of an element-value pair is AnnotationValue.OfLong^PREVIEW.

See Also:

• Constant Field Values

TAG_SHORT

static final int TAG_SHORT

The tag indicating the value of an element-value pair is AnnotationValue.OfShort^PREVIEW.

See Also:

• Constant Field Values

TAG_BOOLEAN

static final int TAG_BOOLEAN

The tag indicating the value of an element-value pair is AnnotationValue.OfBoolean^PREVIEW.

See Also:

• Constant Field Values

TAG_STRING

static final int TAG_STRING

The tag indicating the value of an element-value pair is AnnotationValue.OfString^PREVIEW.

See Also:

• Constant Field Values

TAG_ENUM

static final int TAG_ENUM

The tag indicating the value of an element-value pair is AnnotationValue.OfEnum^PREVIEW.

See Also:

• Constant Field Values

TAG_CLASS

static final int TAG_CLASS

The tag indicating the value of an element-value pair is AnnotationValue.OfClass^PREVIEW.

See Also:

• Constant Field Values

TAG_ANNOTATION

static final int TAG_ANNOTATION

The tag indicating the value of an element-value pair is AnnotationValue.OfAnnotation^PREVIEW.

See Also:

• Constant Field Values

TAG_ARRAY

static final int TAG_ARRAY

The tag indicating the value of an element-value pair is AnnotationValue.OfArray^PREVIEW.

See Also:

• Constant Field Values

Method Details

tag

char tag()

Returns the tag character for this value as per JVMS 4.7.16.1. The tag characters have a one-to-one mapping to the types of annotation element values.

API Note:

TAG_-prefixed constants in this class, such as TAG_INT, describe the possible return values of this method.

Returns:

the tag character for this value as per JVMS 4.7.16.1

ofEnum

static AnnotationValue.OfEnumPREVIEW ofEnum(Utf8EntryPREVIEW className,
 Utf8EntryPREVIEW constantName)

Returns an enum value for an element-value pair.

Parameters:

className - the descriptor string of the enum class

constantName - the name of the enum constant

Returns:

an enum value for an element-value pair

ofEnum

static AnnotationValue.OfEnumPREVIEW ofEnum(ClassDesc className,
 String constantName)

Returns an enum value for an element-value pair.

Parameters:

className - the descriptor of the enum class

constantName - the name of the enum constant

Returns:

an enum value for an element-value pair

ofClass

static AnnotationValue.OfClassPREVIEW ofClass(Utf8EntryPREVIEW className)

Returns a class value for an element-value pair.

Parameters:

className - the descriptor string of the class

Returns:

a class value for an element-value pair

ofClass

static AnnotationValue.OfClassPREVIEW ofClass(ClassDesc className)

Returns a class value for an element-value pair.

Parameters:

className - the descriptor of the class

Returns:

a class value for an element-value pair

ofString

static AnnotationValue.OfStringPREVIEW ofString(Utf8EntryPREVIEW value)

Returns a string value for an element-value pair.

Parameters:

value - the string

Returns:

a string value for an element-value pair

ofString

static AnnotationValue.OfStringPREVIEW ofString(String value)

Returns a string value for an element-value pair.

Parameters:

value - the string

Returns:

a string value for an element-value pair

ofDouble

static AnnotationValue.OfDoublePREVIEW ofDouble(DoubleEntryPREVIEW value)

Returns a double value for an element-value pair.

Parameters:

value - the double value

Returns:

a double value for an element-value pair

ofDouble

static AnnotationValue.OfDoublePREVIEW ofDouble(double value)

Returns a double value for an element-value pair.

Parameters:

value - the double value

Returns:

a double value for an element-value pair

ofFloat

static AnnotationValue.OfFloatPREVIEW ofFloat(FloatEntryPREVIEW value)

Returns a float value for an element-value pair.

Parameters:

value - the float value

Returns:

a float value for an element-value pair

ofFloat

static AnnotationValue.OfFloatPREVIEW ofFloat(float value)

Returns a float value for an element-value pair.

Parameters:

value - the float value

Returns:

a float value for an element-value pair

ofLong

static AnnotationValue.OfLongPREVIEW ofLong(LongEntryPREVIEW value)

Returns a long value for an element-value pair.

Parameters:

value - the long value

Returns:

a long value for an element-value pair

ofLong

static AnnotationValue.OfLongPREVIEW ofLong(long value)

Returns a long value for an element-value pair.

Parameters:

value - the long value

Returns:

a long value for an element-value pair

ofInt

static AnnotationValue.OfIntPREVIEW ofInt(IntegerEntryPREVIEW value)

Returns an int value for an element-value pair.

Parameters:

value - the int value

Returns:

an int value for an element-value pair

ofInt

static AnnotationValue.OfIntPREVIEW ofInt(int value)

Returns an int value for an element-value pair.

Parameters:

value - the int value

Returns:

an int value for an element-value pair

ofShort

static AnnotationValue.OfShortPREVIEW ofShort(IntegerEntryPREVIEW value)

Returns a short value for an element-value pair.

Parameters:

value - the short value

Returns:

a short value for an element-value pair

ofShort

static AnnotationValue.OfShortPREVIEW ofShort(short value)

Returns a short value for an element-value pair.

Parameters:

value - the short value

Returns:

a short value for an element-value pair

ofChar

static AnnotationValue.OfCharPREVIEW ofChar(IntegerEntryPREVIEW value)

Returns a char value for an element-value pair.

Parameters:

value - the char value

Returns:

a char value for an element-value pair

ofChar

static AnnotationValue.OfCharPREVIEW ofChar(char value)

Returns a char value for an element-value pair.

Parameters:

value - the char value

Returns:

a char value for an element-value pair

ofByte

static AnnotationValue.OfBytePREVIEW ofByte(IntegerEntryPREVIEW value)

Returns a byte value for an element-value pair.

Parameters:

value - the byte value

Returns:

a byte value for an element-value pair

ofByte

static AnnotationValue.OfBytePREVIEW ofByte(byte value)

Returns a byte value for an element-value pair.

Parameters:

value - the byte value

Returns:

a byte value for an element-value pair

ofBoolean

static AnnotationValue.OfBooleanPREVIEW ofBoolean(IntegerEntryPREVIEW value)

Returns a boolean value for an element-value pair.

Parameters:

value - the boolean value

Returns:

a boolean value for an element-value pair

ofBoolean

static AnnotationValue.OfBooleanPREVIEW ofBoolean(boolean value)

Returns a boolean value for an element-value pair.

Parameters:

value - the boolean value

Returns:

a boolean value for an element-value pair

ofAnnotation

static AnnotationValue.OfAnnotationPREVIEW ofAnnotation(AnnotationPREVIEW value)

Returns an annotation value for an element-value pair.

Parameters:

value - the annotation

Returns:

an annotation value for an element-value pair

ofArray

static AnnotationValue.OfArrayPREVIEW ofArray(List<AnnotationValuePREVIEW> values)

Returns an array value for an element-value pair.

API Note:

See values()^PREVIEW for conventions on array values derived from Java source code.

Parameters:

values - the array elements

Returns:

an array value for an element-value pair

ofArray

static AnnotationValue.OfArrayPREVIEW ofArray(AnnotationValuePREVIEW... values)

Returns an array value for an element-value pair.

API Note:

See values()^PREVIEW for conventions on array values derived from Java source code.

Parameters:

values - the array elements

Returns:

an array value for an element-value pair

of

static AnnotationValuePREVIEW of(Object value)

Returns an annotation element. The value parameter must be a primitive, a wrapper of primitive, a String, a ClassDesc, an enum constant, or an array of one of these.

Parameters:

value - the annotation value

Returns:

an annotation element

Throws:

IllegalArgumentException - when the value parameter is not a primitive, a wrapper of primitive, a String, a ClassDesc, an enum constant, or an array of one of these.