spoon.support.reflect.declaration

Class CtAnnotationImpl<A extends Annotation>

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.declaration.CtAnnotationImpl<A>

All Implemented Interfaces:

Serializable, Comparable<CtElement>, FactoryAccessor, CtAnnotation<A>, CtElement

public class CtAnnotationImpl<A extends Annotation>
extends CtElementImpl
implements CtAnnotation<A>

The implementation for CtAnnotation.

Author:

Renaud Pawlak

See Also:

Serialized Form

Field Summary

Fields inherited from class spoon.support.reflect.declaration.CtElementImpl

logger

Constructor Summary

Constructors

Constructor and Description
CtAnnotationImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(CtVisitor visitor) Accepts a visitor.
protected void	appendValues(String elementName, Object... values)
A	getActualAnnotation() Returns the actual annotation (a dynamic proxy for this element).
CtElement	getAnnotatedElement() Returns the element which is annotated by this annotation.
CtAnnotatedElementType	getAnnotatedElementType() Returns the type of the element which is annotated by this annotation.
CtTypeReference<A>	getAnnotationType() Returns the annotation type of this annotation.
<T> T	getElementValue(String key) Gets a value for a given key (with conversion if needed).
Map<String,Object>	getElementValues() Returns this annotation's elements and their values.
void	setAnnotationType(CtTypeReference<? extends Annotation> annotationType) Sets the annotation's type.
void	setElementValues(Map<String,Object> values) Set's this annotation's element names and their values.

Methods inherited from class spoon.support.reflect.declaration.CtElementImpl

addAnnotation, compareTo, EMPTY_COLLECTION, EMPTY_LIST, EMPTY_SET, equals, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getDocComment, getElements, getFactory, getParent, getParent, getParentNoExceptions, getPosition, getReferencedTypes, getReferences, getSignature, hashCode, hasParent, isImplicit, isParentInitialized, isRootElement, removeAnnotation, replace, replace, setAnnotations, setDocComment, setFactory, setImplicit, setParent, setPosition, setPositions, setRootElement, toString, updateAllParentsBelow

Methods inherited from class java.lang.Object

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

Methods inherited from interface spoon.reflect.declaration.CtElement

addAnnotation, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getDocComment, getElements, getParent, getParent, getPosition, getReferencedTypes, getReferences, getSignature, hasParent, isImplicit, isParentInitialized, isRootElement, removeAnnotation, replace, setAnnotations, setDocComment, setImplicit, setParent, setPosition, setPositions, setRootElement, updateAllParentsBelow

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

CtAnnotationImpl

public CtAnnotationImpl()

Method Detail

accept

public void accept(CtVisitor visitor)

Description copied from interface: CtElement

Accepts a visitor.

Specified by:

accept in interface CtElement

Parameters:

visitor - to accept

appendValues

protected void appendValues(String elementName,
                Object... values)

getActualAnnotation

public A getActualAnnotation()

Description copied from interface: CtAnnotation

Returns the actual annotation (a dynamic proxy for this element).

NOTE: before using an annotation proxy, you have to make sure that all the types referenced by the annotation have been compiled and are in the classpath so that accessed values can be converted into the actual types (CtAnnotation.getElementValue(String)).

Specified by:

getActualAnnotation in interface CtAnnotation<A extends Annotation>

getAnnotationType

public CtTypeReference<A> getAnnotationType()

Description copied from interface: CtAnnotation

Returns the annotation type of this annotation.

Specified by:

getAnnotationType in interface CtAnnotation<A extends Annotation>

Returns:

a reference to the type of this annotation

getElementValue

public <T> T getElementValue(String key)

Description copied from interface: CtAnnotation

Gets a value for a given key (with conversion if needed).

NOTE: in case of a type, the value is converted to the actual type. To access the type as a reference, use CtAnnotation.getElementValues(), which returns a map containing the raw (unconverted) values.

Specified by:

getElementValue in interface CtAnnotation<A extends Annotation>

Parameters:

key - name of searched value

Returns:

the value or null if not found

getElementValues

public Map<String,Object> getElementValues()

Description copied from interface: CtAnnotation

Returns this annotation's elements and their values. This is returned in the form of a map that associates element names with their corresponding values.

Note that getElementValue("key") is not completely similar to getElementValues().get("key") since the former converts type references into the actual types.

Specified by:

getElementValues in interface CtAnnotation<A extends Annotation>

Returns:

this annotation's element names and their values, or an empty map if there are none

setAnnotationType

public void setAnnotationType(CtTypeReference<? extends Annotation> annotationType)

Description copied from interface: CtAnnotation

Sets the annotation's type.

Specified by:

setAnnotationType in interface CtAnnotation<A extends Annotation>

Parameters:

annotationType - reference to the type of this annotation

setElementValues

public void setElementValues(Map<String,Object> values)

Description copied from interface: CtAnnotation

Set's this annotation's element names and their values. This is in the form of a map that associates element names with their corresponding values. Note that type values are stored as CtTypeReference.

Specified by:

setElementValues in interface CtAnnotation<A extends Annotation>

getAnnotatedElement

public CtElement getAnnotatedElement()

Description copied from interface: CtAnnotation

Returns the element which is annotated by this annotation.

Specified by:

getAnnotatedElement in interface CtAnnotation<A extends Annotation>

Returns:

annotated CtElement

getAnnotatedElementType

public CtAnnotatedElementType getAnnotatedElementType()

Description copied from interface: CtAnnotation

Returns the type of the element which is annotated by this annotation.

Specified by:

getAnnotatedElementType in interface CtAnnotation<A extends Annotation>

Returns:

CtAnnotatedElementType