Package spoon.support.reflect.declaration

Class CtAnnotationImpl<A extends Annotation>

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.code.CtCodeElementImpl

spoon.support.reflect.code.CtExpressionImpl<A>

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

All Implemented Interfaces:

Serializable, Cloneable, FactoryAccessor, CtCodeElement, CtExpression<A>, SourcePositionHolder, CtAnnotation<A>, CtElement, CtShadowable, CtTypedElement<A>, CtQueryable, CtVisitable, TemplateParameter<A>

public class CtAnnotationImpl<A extends Annotation>
extends CtExpressionImpl<A>
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

ERROR_MESSAGE_TO_STRING, factory, LOGGER, parent

Constructor Summary

Constructors

Constructor	Description
CtAnnotationImpl()

Method Summary

Modifier and Type	Method	Description
void	accept(CtVisitor visitor)	Accepts a visitor
<T extends CtAnnotation<A>> T	addValue(String elementName, Object value)	Adds a new key-value pair for this annotation
<T extends CtAnnotation<A>> T	addValue(String elementName, CtFieldAccess<?> value)	Adds a new key-field access pair for this annotation.
<T extends CtAnnotation<A>> T	addValue(String elementName, CtLiteral<?> value)	Adds a new key-literal pair for this annotation.
<T extends CtAnnotation<A>> T	addValue(String elementName, CtNewArray<? extends CtExpression> value)	Adds a new key-array pair for this annotation.
<T extends CtAnnotation<A>> T	addValue(String elementName, CtAnnotation<?> value)	Adds a new key-annotation pair for this annotation.
CtAnnotation<A>	clone()	Clone the element which calls this method in a new object.
A	getActualAnnotation()	Returns the actual annotation (a dynamic proxy for this element).
Map<String,CtExpression>	getAllValues()	Get all values of CtAnnotation.getValues(), plus the default ones defined in the annotation type.
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.
Map<String,Object>	getElementValues()
String	getName()	Returns the class name of the annotation, eg "Deprecated" for @Deprecated.
List<CtTypeReference<?>>	getTypeCasts()	Returns the type casts if any.
<T extends CtExpression> T	getValue(String key)	Gets a value, as a CtExpression, for a given key without any conversion.
int	getValueAsInt(String key)	Returns the actual value of an annotation property, as an integer (utility method)
Object	getValueAsObject(String key)	Returns the actual value of an annotation property
String	getValueAsString(String key)	Returns the actual value of an annotation property, as a String (utility method)
Map<String,CtExpression>	getValues()	Returns this annotation's elements and their values.
<T extends CtExpression> T	getWrappedValue(String key)	Gets a value for a given key and try to fix its type based on the annotation type.
boolean	isShadow()	When an element isn't present in the factory (created in another factory), this element is considered as "shadow".
<T extends CtAnnotation<A>> T	setAnnotationType(CtTypeReference<? extends Annotation> annotationType)	Sets the annotation's type.
<T extends CtAnnotation<A>> T	setElementValues(Map<String,Object> values)	Set's this annotation's element names and their values.
<E extends CtShadowable> E	setShadow(boolean isShadow)	Marks an element as shadow.
<C extends CtExpression<A>> C	setTypeCasts(List<CtTypeReference<?>> casts)	Sets the type casts.
<T extends CtAnnotation<A>> T	setValues(Map<String,CtExpression> values)	Set's this annotation's element names and their values.

Methods inherited from class spoon.support.reflect.code.CtExpressionImpl

addTypeCast, getType, S, setType

Methods inherited from class spoon.support.reflect.code.CtCodeElementImpl

partiallyEvaluate

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

addAnnotation, addComment, asIterable, comment, delete, descendantIterator, emptyList, emptySet, equals, filterChildren, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getFactory, getMetadata, getMetadataKeys, getOriginalSourceFragment, getParent, getParent, getParent, getPath, getPosition, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hashCode, hasParent, isImplicit, isParentInitialized, map, map, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setFactory, setImplicit, setParent, setPosition, setPositions, setValueByRole, toString, toStringDebug, unmodifiableList, updateAllParentsBelow

Methods inherited from class java.lang.Object

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

Methods inherited from interface spoon.reflect.code.CtCodeElement

partiallyEvaluate

Methods inherited from interface spoon.reflect.declaration.CtElement

addAnnotation, addComment, asIterable, delete, descendantIterator, getAllMetadata, getAnnotatedChildren, getAnnotation, getAnnotation, getAnnotations, getComments, getDirectChildren, getDocComment, getElements, getMetadata, getMetadataKeys, getOriginalSourceFragment, getParent, getParent, getParent, getPath, getPosition, getReferencedTypes, getRoleInParent, getShortRepresentation, getValueByRole, hasAnnotation, hasParent, isImplicit, isParentInitialized, prettyprint, putMetadata, removeAnnotation, removeComment, replace, replace, setAllMetadata, setAnnotations, setComments, setDocComment, setImplicit, setParent, setPosition, setPositions, setValueByRole, toString, toStringDebug, updateAllParentsBelow

Methods inherited from interface spoon.reflect.code.CtExpression

addTypeCast

Methods inherited from interface spoon.reflect.visitor.chain.CtQueryable

filterChildren, map, map

Methods inherited from interface spoon.reflect.declaration.CtTypedElement

getType, setType

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Methods inherited from interface spoon.template.TemplateParameter

S

Constructor Detail

CtAnnotationImpl

public CtAnnotationImpl()

Method Detail

accept

public void accept(CtVisitor visitor)

Description copied from interface: CtVisitable

Accepts a visitor

Specified by:

accept in interface CtVisitable

addValue

public <T extends CtAnnotation<A>> T addValue(String elementName,
                                              Object value)

Description copied from interface: CtAnnotation

Adds a new key-value pair for this annotation

Specified by:

addValue in interface CtAnnotation<A extends Annotation>

addValue

public <T extends CtAnnotation<A>> T addValue(String elementName,
                                              CtLiteral<?> value)

Description copied from interface: CtAnnotation

Adds a new key-literal pair for this annotation.

Specified by:

addValue in interface CtAnnotation<A extends Annotation>

addValue

public <T extends CtAnnotation<A>> T addValue(String elementName,
                                              CtNewArray<? extends CtExpression> value)

Description copied from interface: CtAnnotation

Adds a new key-array pair for this annotation.

Specified by:

addValue in interface CtAnnotation<A extends Annotation>

addValue

public <T extends CtAnnotation<A>> T addValue(String elementName,
                                              CtFieldAccess<?> value)

Description copied from interface: CtAnnotation

Adds a new key-field access pair for this annotation.

Specified by:

addValue in interface CtAnnotation<A extends Annotation>

addValue

public <T extends CtAnnotation<A>> T addValue(String elementName,
                                              CtAnnotation<?> value)

Description copied from interface: CtAnnotation

Adds a new key-annotation pair for this annotation.

Specified by:

addValue 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

getValue

public <T extends CtExpression> T getValue(String key)

Description copied from interface: CtAnnotation

Gets a value, as a CtExpression, for a given key without any conversion. If you need the actual value (eg an integer and not a literal, see CtAnnotation.getValueAsObject(String) and similar methods. Note that this value type does not necessarily corresponds to the annotation type member. For example, in case the annotation type expect an array of Object, and a single value is given, Spoon will return only the object without the CtNewArray. If you want to get a type closer to the annotation type one, see CtAnnotation.getWrappedValue(String).

Specified by:

getValue in interface CtAnnotation<A extends Annotation>

Parameters:

key - Name of searched value.

Returns:

the value expression or null if not found.

getValueAsInt

public int getValueAsInt(String key)

Description copied from interface: CtAnnotation

Returns the actual value of an annotation property, as an integer (utility method)

Specified by:

getValueAsInt in interface CtAnnotation<A extends Annotation>

getValueAsString

public String getValueAsString(String key)

Description copied from interface: CtAnnotation

Returns the actual value of an annotation property, as a String (utility method)

Specified by:

getValueAsString in interface CtAnnotation<A extends Annotation>

getValueAsObject

public Object getValueAsObject(String key)

Description copied from interface: CtAnnotation

Returns the actual value of an annotation property

Specified by:

getValueAsObject in interface CtAnnotation<A extends Annotation>

getWrappedValue

public <T extends CtExpression> T getWrappedValue(String key)

Description copied from interface: CtAnnotation

Gets a value for a given key and try to fix its type based on the annotation type. For example, if the annotation type member expects an array of String, and it can be resolved, this method will return a CtNewArray instead of a CtLiteral. Warning: the returned element might be detached from the model

Specified by:

getWrappedValue in interface CtAnnotation<A extends Annotation>

Parameters:

key - Name of searched value.

Returns:

the value expression or null if not found.

getElementValues

public Map<String,Object> getElementValues()

getValues

public Map<String,CtExpression> getValues()

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. If you iterate over the map with entrySet(), the iteration order complies with the order of annotation values in the source code.

Specified by:

getValues in interface CtAnnotation<A extends Annotation>

Returns:

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

getAllValues

public Map<String,CtExpression> getAllValues()

Description copied from interface: CtAnnotation

Get all values of CtAnnotation.getValues(), plus the default ones defined in the annotation type.

Specified by:

getAllValues in interface CtAnnotation<A extends Annotation>

setAnnotationType

public <T extends CtAnnotation<A>> T 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 <T extends CtAnnotation<A>> T 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>

setValues

public <T extends CtAnnotation<A>> T setValues(Map<String,CtExpression> 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.

Specified by:

setValues 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

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.

Specified by:

getActualAnnotation in interface CtAnnotation<A extends Annotation>

isShadow

public boolean isShadow()

Description copied from interface: CtShadowable

When an element isn't present in the factory (created in another factory), this element is considered as "shadow". e.g., a shadow element can be a CtType of java.lang.Class built when we call CtTypeReference.getTypeDeclaration() on a reference of java.lang.Class.

Specified by:

isShadow in interface CtShadowable

Returns:

true if the element is a shadow element, otherwise false.

setShadow

public <E extends CtShadowable> E setShadow(boolean isShadow)

Description copied from interface: CtShadowable

Marks an element as shadow. To know what is a shadow element, see the javadoc of CtShadowable.isShadow().

Specified by:

setShadow in interface CtShadowable

clone

public CtAnnotation<A> clone()

Description copied from interface: CtElement

Clone the element which calls this method in a new object. Note that that references are kept as is, and thus, so if you clone whole classes or methods, some parts of the cloned element (eg executable references) may still point to the initial element. In this case, consider using methods Refactoring.copyType(CtType) and Refactoring.copyMethod(CtMethod) instead which does additional work beyond cloning.

Specified by:

clone in interface CtAnnotation<A extends Annotation>

Specified by:

clone in interface CtCodeElement

Specified by:

clone in interface CtElement

Specified by:

clone in interface CtExpression<A extends Annotation>

Overrides:

clone in class CtExpressionImpl<A extends Annotation>

getTypeCasts

public List<CtTypeReference<?>> getTypeCasts()

Description copied from interface: CtExpression

Returns the type casts if any.

Specified by:

getTypeCasts in interface CtExpression<A extends Annotation>

Overrides:

getTypeCasts in class CtExpressionImpl<A extends Annotation>

setTypeCasts

public <C extends CtExpression<A>> C setTypeCasts(List<CtTypeReference<?>> casts)

Description copied from interface: CtExpression

Sets the type casts.

Specified by:

setTypeCasts in interface CtAnnotation<A extends Annotation>

Specified by:

setTypeCasts in interface CtExpression<A extends Annotation>

Overrides:

setTypeCasts in class CtExpressionImpl<A extends Annotation>

getName

public String getName()

Description copied from interface: CtAnnotation

Returns the class name of the annotation, eg "Deprecated" for @Deprecated.

Specified by:

getName in interface CtAnnotation<A extends Annotation>

Returns:

the name of the annotation