Package org.apache.xmlbeans.impl.jam.internal.elements

Class AnnotationValueImpl

    • Method Detail

      • isDefaultValueUsed

        public boolean isDefaultValueUsed()
        Description copied from interface: JAnnotationValue

        Returns true if the member's value was not explicitly set in the annotation instance but was instead taken from the member definition's default.

        Note that not all JAM implementations may be able to distinguish the case where the value is explicitly declared to be the same value as the member's default from the case where the value is not declared and the value is implicitly default. In this event, this method will return true if and only if the effective value of the annotation is the same as the default value (regardless of how that value was declared).

        Specified by:
        isDefaultValueUsed in interface JAnnotationValue

      • asAnnotation

        public JAnnotation asAnnotation()
        Description copied from interface: JAnnotationValue

        If this member is complex (i.e. an instance of another annotation type), this method returns a representation of the annotation instance. Returns null in all other samples. This method always returns null if the annotation is a javdoc tag, as such tags only support one level of nesting.

        Specified by:
        asAnnotation in interface JAnnotationValue

      • asClass

        public JClass asClass()
        Description copied from interface: JAnnotationValue

        Returns the value of this member as a JClass. Returns null if the value cannot be understood as a class name or if the type of the member is known to be something other than java.lang.Class.

        Specified by:
        asClass in interface JAnnotationValue

      • asString

        public String asString()
        Description copied from interface: JAnnotationValue

        Returns the String value of the annotation. If the value is known to be a simple, non-array type other than String, it will be converted in a resonable manner (with an appropriate toString() or String.valueOf() method). If the value is known to be complex or is an array, this method will return null.

        If no type information is available for the annotation member (i.e. it's a javadoc tag), then the raw textual value of the member is returned.

        Specified by:
        asString in interface JAnnotationValue

      • asInt

        public int asInt()
          throws NumberFormatException
        Description copied from interface: JAnnotationValue

        Returns the member's value as an int. If the value is not known to be an int, (because it's a javadoc tag or because it's a 175 annotation member of a type other than int) asString() is called. If the result is null, NumberFormatException is thrown. Otherwise, the String is converted to an int with Integer.valueOf(), which again may throw NumberFormatException.

        Specified by:
        asInt in interface JAnnotationValue
        Throws:
        NumberFormatException

      • asClassArray

        public JClass[] asClassArray()
        Description copied from interface: JAnnotationValue

        If this member is known to be an array of classes, returns an array of JClass representations of those classes. If the memeber is known to be an array of a simple non-array type, this method will call asStringArray() and attempt to return a JClass by treating each string in the returned array as a qualified classname. Returns null otherwise.

        This method always returns null for javadoc tags.

        Specified by:
        asClassArray in interface JAnnotationValue

      • asAnnotationArray

        public JAnnotation[] asAnnotationArray()
        Description copied from interface: JAnnotationValue

        If this member is known to be an array of annotations (i.e. complex, nested types), this method returns an array containing each complex value as a JAnnotation. Returns null in all other samples.

        This method always returns null for javadoc tags.

        Specified by:
        asAnnotationArray in interface JAnnotationValue

      • asStringArray

        public String[] asStringArray()
        Description copied from interface: JAnnotationValue

        Returns this member's value as an array of Strings. If this member is not of an array type, or is an array of arrays or complex annotations, this method returns null. If it is an array of a simple, non-array type other than String, conversion on each component will be attempted as described under getStringValue().

        This method always returns null for javadoc tags.

        Specified by:
        asStringArray in interface JAnnotationValue

      • asIntArray

        public int[] asIntArray()
                 throws NumberFormatException
        Description copied from interface: JAnnotationValue

        Returns this member's value as an array of ints. If this member is not of an array type, or is an array of arrays or complex annotations, this method returns null. If it is an array of a simple, non-array type other than int, conversion on each component will be attempted as described under getIntValue().

        This method always returns null for javadoc tags.

        Specified by:
        asIntArray in interface JAnnotationValue
        Throws:
        NumberFormatException

      • asBooleanArray

        public boolean[] asBooleanArray()
                         throws IllegalArgumentException
        Description copied from interface: JAnnotationValue

        Returns this member's value as an array of booleans. If necessary, type conversion is performed in a similar manner as described for asIntArray(), except that IllegalArgumentException may be thrown instead of NumberFormatException.

        This method always returns null for javadoc tags.

        Specified by:
        asBooleanArray in interface JAnnotationValue
        Throws:
        IllegalArgumentException