Interface AnnotationValue.OfConstant

All Superinterfaces:

AnnotationValuePREVIEW

All Known Subinterfaces:

AnnotationValue.OfBooleanPREVIEW, AnnotationValue.OfBytePREVIEW, AnnotationValue.OfCharPREVIEW, AnnotationValue.OfDoublePREVIEW, AnnotationValue.OfFloatPREVIEW, AnnotationValue.OfIntPREVIEW, AnnotationValue.OfLongPREVIEW, AnnotationValue.OfShortPREVIEW, AnnotationValue.OfStringPREVIEW

Enclosing interface:

AnnotationValuePREVIEW

public static sealed interface AnnotationValue.OfConstant
extends AnnotationValuePREVIEW
permits AnnotationValue.OfStringPREVIEW, AnnotationValue.OfDoublePREVIEW, AnnotationValue.OfFloatPREVIEW, AnnotationValue.OfLongPREVIEW, AnnotationValue.OfIntPREVIEW, AnnotationValue.OfShortPREVIEW, AnnotationValue.OfCharPREVIEW, AnnotationValue.OfBytePREVIEW, AnnotationValue.OfBooleanPREVIEW

OfConstant is a preview API of the Java platform.

Programs can only use OfConstant when preview features are enabled.

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

Models a constant value of an element-value pair.

Since:

22

Nested Class Summary

Nested classes/interfaces declared in interface java.lang.classfile.AnnotationValue^PREVIEW

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

Field Summary

Fields declared in interface java.lang.classfile.AnnotationValue^PREVIEW

TAG_ANNOTATION, TAG_ARRAY, TAG_BOOLEAN, TAG_BYTE, TAG_CHAR, TAG_CLASS, TAG_DOUBLE, TAG_ENUM, TAG_FLOAT, TAG_INT, TAG_LONG, TAG_SHORT, TAG_STRING

Method Summary

Modifier and Type	Method	Description
AnnotationConstantValueEntryPREVIEW	constant()	Returns the constant pool entry backing this constant element.
Constable	resolvedValue()	Returns the resolved live constant value, as an object.

Methods declared in interface java.lang.classfile.AnnotationValue^PREVIEW

tag

Method Details

constant

AnnotationConstantValueEntryPREVIEW constant()

Returns the constant pool entry backing this constant element.

API Note:

Different types of constant values may share the same type of entry because they have the same computational type. For example, AnnotationValue.OfInt^PREVIEW and AnnotationValue.OfChar^PREVIEW are both backed by IntegerEntry^PREVIEW. Use resolvedValue() for a value of accurate type.

Returns:

the constant pool entry backing this constant element

resolvedValue

Constable resolvedValue()

Returns the resolved live constant value, as an object. The type of the returned value may be a wrapper class or String.

API Note:

The returned object, despite being Constable, may not describe the right constant for encoding the annotation value in a class file. For example, Character returned by AnnotationValue.OfChar^PREVIEW describes itself as a DynamicConstantPoolEntry^PREVIEW, but it is actually backed by IntegerEntry^PREVIEW in annotation format. Use constant() for a correct constant pool representation.

Returns:

the resolved live constant value, as an object