org.jboss.forge.roaster.model

Interface Annotation<O extends JavaType<O>>

Type Parameters:

O - the java type which can be annotated

All Superinterfaces:

Internal, Origin<O>

All Known Subinterfaces:

AnnotationSource<O>

public interface Annotation<O extends JavaType<O>>
extends Internal, Origin<O>

Represents an annotation on a Java element.

Author:

Lincoln Baxter, III

Method Summary

Modifier and Type	Method and Description
Annotation<O>[]	getAnnotationArrayValue()
Annotation<O>[]	getAnnotationArrayValue(String name)
Annotation<O>	getAnnotationValue()
Annotation<O>	getAnnotationValue(String name)
Class<?>[]	getClassArrayValue()
Class<?>[]	getClassArrayValue(String name)
Class<?>	getClassValue()
Class<?>	getClassValue(String name)
<T extends Enum<T>> T[]	getEnumArrayValue(Class<T> type)
<T extends Enum<T>> T[]	getEnumArrayValue(Class<T> type, String name)
<T extends Enum<T>> T	getEnumValue(Class<T> type)
<T extends Enum<T>> T	getEnumValue(Class<T> type, String name)
String	getLiteralValue()
String	getLiteralValue(String name)
String	getName() Get the simple name of this annotation.
String	getQualifiedName() Get the qualified name of this annotation.
String[]	getStringArrayValue()
String[]	getStringArrayValue(String name)
String	getStringValue()
String	getStringValue(String name)
List<ValuePair>	getValues()
boolean	isMarker() Checks if this annotation is a marker annotation.
boolean	isNormal()
boolean	isSingleValue()
boolean	isTypeElementDefined(String name)

Methods inherited from interface org.jboss.forge.roaster.Internal

getInternal

Methods inherited from interface org.jboss.forge.roaster.Origin

getOrigin

Method Detail

isSingleValue

boolean isSingleValue()

isMarker

boolean isMarker()

Checks if this annotation is a marker annotation. A marker annotation is defined as @TypeName, e.g. @Overwrite. The annotation has no value.

Returns:

true, if this annotation is a marker annotation, false otherwise.

isNormal

boolean isNormal()

getName

String getName()

Get the simple name of this annotation.

NOTE: This method returns always the simple name indifferent if the type was imported or not.

Returns:

the simple name

See Also:

Types.toSimpleName(String)

getQualifiedName

String getQualifiedName()

Get the qualified name of this annotation.

NOTE: This method returns always the qualified name indifferent if the type was imported or not.

Returns:

the qualified name

getEnumValue

<T extends Enum<T>> T getEnumValue(Class<T> type)

getEnumValue

<T extends Enum<T>> T getEnumValue(Class<T> type,
                                   String name)

getEnumArrayValue

<T extends Enum<T>> T[] getEnumArrayValue(Class<T> type)

getEnumArrayValue

<T extends Enum<T>> T[] getEnumArrayValue(Class<T> type,
                                          String name)

getLiteralValue

String getLiteralValue()

getLiteralValue

String getLiteralValue(String name)

getValues

List<ValuePair> getValues()

getStringValue

String getStringValue()

getStringValue

String getStringValue(String name)

getStringArrayValue

String[] getStringArrayValue()

getStringArrayValue

String[] getStringArrayValue(String name)

getAnnotationValue

Annotation<O> getAnnotationValue()

getAnnotationValue

Annotation<O> getAnnotationValue(String name)

getAnnotationArrayValue

Annotation<O>[] getAnnotationArrayValue()

getAnnotationArrayValue

Annotation<O>[] getAnnotationArrayValue(String name)

getClassValue

Class<?> getClassValue()

getClassValue

Class<?> getClassValue(String name)

getClassArrayValue

Class<?>[] getClassArrayValue()

getClassArrayValue

Class<?>[] getClassArrayValue(String name)

isTypeElementDefined

boolean isTypeElementDefined(String name)