org.jboss.jandex

Class AnnotationValue.EnumValue

java.lang.Object

org.jboss.jandex.AnnotationValue

org.jboss.jandex.AnnotationValue.EnumValue

Enclosing class:

AnnotationValue

static final class AnnotationValue.EnumValue
extends AnnotationValue

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.jandex.AnnotationValue

AnnotationValue.ArrayValue, AnnotationValue.BooleanValue, AnnotationValue.ByteValue, AnnotationValue.CharacterValue, AnnotationValue.ClassValue, AnnotationValue.DoubleValue, AnnotationValue.EnumValue, AnnotationValue.FloatValue, AnnotationValue.IntegerValue, AnnotationValue.Kind, AnnotationValue.LongValue, AnnotationValue.NestedAnnotation, AnnotationValue.ShortValue, AnnotationValue.StringValue

Field Summary

Fields

Modifier and Type	Field and Description
private DotName	typeName
private java.lang.String	value

Fields inherited from class org.jboss.jandex.AnnotationValue

EMPTY_VALUE_ARRAY

Constructor Summary

Constructors

Constructor and Description
EnumValue(java.lang.String name, DotName typeName, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
java.lang.String	asEnum() Returns the constant name, in string form, that represents the Java enumeration of this value.
DotName	asEnumType() Returns the type name, in DotName form, that represents the Java enumeration of this value.
boolean	equals(java.lang.Object o) Compares this annotation value to another annotation value, and returns true if equal.
int	hashCode() Computes a hash code for this annotation value.
AnnotationValue.Kind	kind() Returns the kind of this value.
java.lang.String	value() Returns a detyped value that represents the underlying annotation value.

Methods inherited from class org.jboss.jandex.AnnotationValue

asArray, asBoolean, asBooleanArray, asByte, asByteArray, asChar, asCharArray, asClass, asClassArray, asDouble, asDoubleArray, asEnumArray, asEnumTypeArray, asFloat, asFloatArray, asInt, asIntArray, asLong, asLongArray, asNested, asNestedArray, asShort, asShortArray, asString, asStringArray, componentKind, createArrayValue, createBooleanValue, createByteValue, createCharacterValue, createClassValue, createDouleValue, createEnumValue, createFloatValue, createIntegerValue, createLongalue, createNestedAnnotationValue, createShortValue, createStringValue, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

value

private final java.lang.String value

typeName

private final DotName typeName

Constructor Detail

EnumValue

EnumValue(java.lang.String name,
          DotName typeName,
          java.lang.String value)

Method Detail

value

public java.lang.String value()

Description copied from class: AnnotationValue

Returns a detyped value that represents the underlying annotation value. It is recommended that the type specific methods be used instead.

Specified by:

value in class AnnotationValue

Returns:

the underlying value

kind

public AnnotationValue.Kind kind()

Description copied from class: AnnotationValue

Returns the kind of this value. The kind includes all Java primitives, String and Enum types, nested values, and finally arrays of the above. Since the return type is itself an enumeration, it can be used with Java switch statements.

A special AnnotationValue.Kind.UNKNOWN kind is used to refer to components of zero-length arrays, as the underlying type is not known.

Specified by:

kind in class AnnotationValue

Returns:

the kind of value

asEnum

public java.lang.String asEnum()

Description copied from class: AnnotationValue

Returns the constant name, in string form, that represents the Java enumeration of this value. The value is the same as the one returned by Enum.name().

Overrides:

asEnum in class AnnotationValue

Returns:

the string name of a Java enumeration

asEnumType

public DotName asEnumType()

Description copied from class: AnnotationValue

Returns the type name, in DotName form, that represents the Java enumeration of this value. The value is the same as the one returned by Object.getClass().

Overrides:

asEnumType in class AnnotationValue

Returns:

the type name of a Java enumeration

equals

public boolean equals(java.lang.Object o)

Description copied from class: AnnotationValue

Compares this annotation value to another annotation value, and returns true if equal.

Overrides:

equals in class AnnotationValue

Parameters:

o - the annotation value to compare to.

Returns:

true if equal, false if not

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: AnnotationValue

Computes a hash code for this annotation value.

Overrides:

hashCode in class AnnotationValue

Returns:

the hash code for this annotation value

See Also:

Object.hashCode()