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:
Sealed class hierarchy graph for AnnotationValueSealed class hierarchy graph for AnnotationValue
Since:
22
See Also:

  • 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.
      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.