Interface AnnotationValue


  • public interface AnnotationValue

    Representation of an annotation value.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      AnnotationInfo getAnnotationValue()
      Answer the value of this annotation value as an annotation.
      java.util.List<? extends AnnotationValue> getArrayValue()
      Answer the value of this annotation value as an array of annotation values.
      java.lang.Boolean getBoolean()
      Answer the value of this annotation value as a boolean object.
      boolean getBooleanValue()
      Answer the value of this annotation value as a simple boolean value.
      java.lang.Byte getByte()
      Answer the value of this annotation value as a byte object.
      byte getByteValue()
      Answer the value of this annotation value as a simple byte value.
      java.lang.Character getCharacter()
      Answer the value of this annotation value as a character object.
      char getCharValue()
      Answer the value of this annotation value as a simple byte value.
      java.lang.String getClassNameValue()
      Answer the class name for an annotation value which is a class reference.
      java.lang.Double getDouble()
      Answer the value of this annotation value as a double object.
      double getDoubleValue()
      Answer the value of this annotation value as a simple double (double precision floating point) value.
      java.lang.String getEnumClassName()
      Answer the name of the class of the stored enumerated value.
      java.lang.String getEnumValue()
      Answer the enumerated value as the value name.
      java.lang.Float getFloat()
      Answer the value of this annotation value as a float object.
      float getFloatValue()
      Answer the value of this annotation value as a simple float (floating point) value.
      java.lang.Integer getInteger()
      Answer the value of this annotation value as an integer object.
      int getIntValue()
      Answer the value of this annotation value as a simple int (integer) value.
      java.lang.Long getLong()
      Answer the value of this annotation value as a long object.
      long getLongValue()
      Answer the value of this annotation value as a simple long value.
      java.lang.Object getObjectValue()
      Answer the raw, untyped, value of this annotation value.
      java.lang.String getStringValue()
      Answer the value of this annotation value as a simple string value.
    • Method Detail

      • getObjectValue

        java.lang.Object getObjectValue()

        Answer the raw, untyped, value of this annotation value.

        The raw value of the annotation is set when the annotation value is constructed, and includes at least a raw value, and may optionally include an the name of the enumeration type of the value.

        When the type of the value is known, a casting getter may be used to retrieve the typed value. See, for example, getLongValue(), amount several typing getters. If the casting getter does not match the set type, a class cast exception will occur.

        Returns:
        The raw, untyped, value of this annotation value.
      • getAnnotationValue

        AnnotationInfo getAnnotationValue()

        Answer the value of this annotation value as an annotation.

        Returns:
        The value of this annotation value, as an annotation itself.
      • getArrayValue

        java.util.List<? extends AnnotationValue> getArrayValue()

        Answer the value of this annotation value as an array of annotation values.

        Returns:
        The elements of the value of this annotation value, ordered, as a list.
      • getBoolean

        java.lang.Boolean getBoolean()

        Answer the value of this annotation value as a boolean object.

        Returns:
        The value of this annotation value as a boolean object.
      • getBooleanValue

        boolean getBooleanValue()

        Answer the value of this annotation value as a simple boolean value.

        Returns:
        The value of this annotation value as a simple boolean value.
      • getByte

        java.lang.Byte getByte()

        Answer the value of this annotation value as a byte object.

        Returns:
        The value of this annotation value as a byte object.
      • getByteValue

        byte getByteValue()

        Answer the value of this annotation value as a simple byte value.

        Returns:
        The value of this annotation value as a simple byte value.
      • getCharacter

        java.lang.Character getCharacter()

        Answer the value of this annotation value as a character object.

        Returns:
        The value of this annotation value as a character object.
      • getCharValue

        char getCharValue()

        Answer the value of this annotation value as a simple byte value.

        Returns:
        The value of this annotation value as a simple byte value.
      • getClassNameValue

        java.lang.String getClassNameValue()

        Answer the class name for an annotation value which is a class reference.

        Returns:
        The class name for a value which is a class reference.
      • getDouble

        java.lang.Double getDouble()

        Answer the value of this annotation value as a double object.

        Returns:
        The value of this annotation value as a double object.
      • getDoubleValue

        double getDoubleValue()

        Answer the value of this annotation value as a simple double (double precision floating point) value.

        Returns:
        The value of this annotation value as a simple double (double precision floating point) value.
      • getEnumClassName

        java.lang.String getEnumClassName()

        Answer the name of the class of the stored enumerated value.

        Returns:
        The name of the class of the stored enumerated value.
        See Also:
        getEnumValue(), #getEnumType()
      • getEnumValue

        java.lang.String getEnumValue()

        Answer the enumerated value as the value name.

        Returns:
        The enumerated value as a value name.
        See Also:
        #getEnumType()
      • getFloat

        java.lang.Float getFloat()

        Answer the value of this annotation value as a float object.

        Returns:
        The value of this annotation value as a float object.
      • getFloatValue

        float getFloatValue()

        Answer the value of this annotation value as a simple float (floating point) value.

        Returns:
        The value of this annotation value as a simple float (floating point) value.
      • getInteger

        java.lang.Integer getInteger()

        Answer the value of this annotation value as an integer object.

        Returns:
        The value of this annotation value as an integer object.
      • getIntValue

        int getIntValue()

        Answer the value of this annotation value as a simple int (integer) value.

        Returns:
        The value of this annotation value as a simple int (integer) value.
      • getLong

        java.lang.Long getLong()

        Answer the value of this annotation value as a long object.

        Returns:
        The value of this annotation value as a long object.
      • getLongValue

        long getLongValue()

        Answer the value of this annotation value as a simple long value.

        Returns:
        The value of this annotation value as a simple long value.
      • getStringValue

        java.lang.String getStringValue()

        Answer the value of this annotation value as a simple string value.

        Returns:
        The value of this annotation value as a simple string value.