spoon.reflect.declaration

Interface CtElement

All Superinterfaces:

Comparable<CtElement>, FactoryAccessor

All Known Subinterfaces:

CtAbstractInvocation<T>, CtAnnotation<A>, CtAnnotationFieldAccess<T>, CtAnnotationType<T>, CtAnonymousExecutable, CtArrayAccess<T,E>, CtAssert<T>, CtAssignment<T,A>, CtBinaryOperator<T>, CtBlock<R>, CtBreak, CtCase<S>, CtCatch, CtCFlowBreak, CtClass<T>, CtCodeElement, CtCodeSnippetExpression<T>, CtCodeSnippetStatement, CtConditional<T>, CtConstructor<T>, CtContinue, CtDo, CtEnum<T>, CtExecutable<R>, CtExpression<T>, CtField<T>, CtFieldAccess<T>, CtFor, CtForEach, CtGenericElement, CtIf, CtInterface<T>, CtInvocation<T>, CtLiteral<T>, CtLocalVariable<T>, CtLoop, CtMethod<T>, CtModifiable, CtNamedElement, CtNewArray<T>, CtNewClass<T>, CtOperatorAssignment<T,A>, CtPackage, CtParameter<T>, CtReturn<R>, CtSimpleType<T>, CtStatement, CtStatementList, CtSuperAccess<T>, CtSwitch<S>, CtSynchronized, CtTargetedAccess<T>, CtTargetedExpression<T,E>, CtThisAccess<T>, CtThrow, CtTry, CtType<T>, CtTypedElement<T>, CtTypeParameter, CtUnaryOperator<T>, CtVariable<T>, CtVariableAccess<T>, CtWhile

All Known Implementing Classes:

CtAnnotationFieldAccesImpl, CtAnnotationImpl, CtAnnotationTypeImpl, CtAnonymousExecutableImpl, CtArrayAccessImpl, CtAssertImpl, CtAssignmentImpl, CtBinaryOperatorImpl, CtBlockImpl, CtBreakImpl, CtCaseImpl, CtCatchImpl, CtClassImpl, CtCodeElementImpl, CtCodeSnippetExpressionImpl, CtCodeSnippetStatementImpl, CtConditionalImpl, CtConstructorImpl, CtContinueImpl, CtDoImpl, CtElementImpl, CtEnumImpl, CtExecutableImpl, CtExpressionImpl, CtFieldAccessImpl, CtFieldImpl, CtForEachImpl, CtForImpl, CtIfImpl, CtInterfaceImpl, CtInvocationImpl, CtLiteralImpl, CtLocalVariableImpl, CtLoopImpl, CtMethodImpl, CtNamedElementImpl, CtNewArrayImpl, CtNewClassImpl, CtOperatorAssignmentImpl, CtPackageImpl, CtParameterImpl, CtReturnImpl, CtSimpleTypeImpl, CtStatementImpl, CtStatementListImpl, CtSuperAccessImpl, CtSwitchImpl, CtSynchronizedImpl, CtTargetedAccessImpl, CtTargetedExpressionImpl, CtThisAccessImpl, CtThrowImpl, CtTryImpl, CtTypeImpl, CtTypeParameterImpl, CtUnaryOperatorImpl, CtVariableAccessImpl, CtWhileImpl

public interface CtElement
extends FactoryAccessor, Comparable<CtElement>

This interface is the root interface for the metamodel elements (any program element).

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(CtVisitor visitor) Accepts a visitor.
boolean	addAnnotation(CtAnnotation<? extends Annotation> annotation) Add an annotation for this element
<E extends CtElement> List<E>	getAnnotatedChildren(Class<? extends Annotation> annotationType) Gets the child elements annotated with the given annotation type's instances.
<A extends Annotation> A	getAnnotation(Class<A> annotationType) Searches for an annotation (proxy) of the given class that annotates the current element.
<A extends Annotation> CtAnnotation<A>	getAnnotation(CtTypeReference<A> annotationType) Gets the annotation element for a given annotation type.
List<CtAnnotation<? extends Annotation>>	getAnnotations() Returns the annotations that are present on this element.
String	getDocComment() Returns the text of the documentation ("javadoc") comment of this element.
<E extends CtElement> List<E>	getElements(Filter<E> filter)
CtElement	getParent() Gets the parent of current element, which can be null.
<P extends CtElement> P	getParent(Class<P> parentType) Gets the first parent that matches the given type.
SourcePosition	getPosition() Gets the position of this element in input source files
Set<CtTypeReference<?>>	getReferencedTypes() Calculates and returns the set of all the types referenced by this element (and sub-elements in the AST).
<T extends CtReference> List<T>	getReferences(ReferenceFilter<T> filter)
String	getSignature() Gets the signature of the element.
boolean	hasParent(CtElement candidate) Tells if the given element is a direct or indirect parent.
boolean	isImplicit() Returns true if this element is implicit and automatically added by the Java compiler.
boolean	isParentInitialized() Tells if this parent has been initialized.
boolean	isRootElement() Tells if this element is a root of the element tree (and thus has no parent, which is different from being not initialized).
boolean	removeAnnotation(CtAnnotation<? extends Annotation> annotation) Remove an annotation for this element
void	replace(CtElement element) Replaces this element by another one.
void	setAnnotations(List<CtAnnotation<? extends Annotation>> annotation) Sets the annotations for this element.
void	setDocComment(String docComment) Sets the text of the documentation ("javadoc") comment of this declaration.
void	setImplicit(boolean b) Sets this element to be implicit (will not be printed).
void	setParent(CtElement element) Manually sets the parent element of the current element.
void	setPosition(SourcePosition position) Sets the position in the Java source file.
void	setPositions(SourcePosition position) Sets the position of this element and all its children element.
void	setRootElement(boolean rootElement) Sets the root element flag to this element.
void	updateAllParentsBelow() Calculates and sets all the parents below this element.

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

accept

void accept(CtVisitor visitor)

Accepts a visitor.

Parameters:

visitor - to accept

getAnnotation

<A extends Annotation> A getAnnotation(Class<A> annotationType)

Searches for an annotation (proxy) of the given class that annotates the current 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. Otherwise, use getAnnotation(CtTypeReference).

Type Parameters:

A - the annotation's type

Parameters:

annotationType - the annotation's class

Returns:

if found, returns a proxy for this annotation

getAnnotation

<A extends Annotation> CtAnnotation<A> getAnnotation(CtTypeReference<A> annotationType)

Gets the annotation element for a given annotation type.

Parameters:

annotationType - the annotation type

Returns:

the annotation if this element is annotated by one annotation of the given type

getAnnotations

List<CtAnnotation<? extends Annotation>> getAnnotations()

Returns the annotations that are present on this element. For sake of encapsulation, the returned list is unmodifiable.

getDocComment

String getDocComment()

Returns the text of the documentation ("javadoc") comment of this element.

getParent

CtElement getParent()
                    throws ParentNotInitializedException

Gets the parent of current element, which can be null. Elements that are manually added to the tree may have a null parent if not manually set. Note that the parents of an entire tree of elements can be automatically set by using the updateAllParentsBelow().

Throws:

ParentNotInitializedException - when the parent of this element is not initialized

isParentInitialized

boolean isParentInitialized()

Tells if this parent has been initialized.

isRootElement

boolean isRootElement()

Tells if this element is a root of the element tree (and thus has no parent, which is different from being not initialized). When an element is a root element, getParent() will return null without throwing an exception.

setRootElement

void setRootElement(boolean rootElement)

Sets the root element flag to this element.

getSignature

String getSignature()

Gets the signature of the element.

getParent

<P extends CtElement> P getParent(Class<P> parentType)
                              throws ParentNotInitializedException

Gets the first parent that matches the given type.

Throws:

ParentNotInitializedException

hasParent

boolean hasParent(CtElement candidate)
                  throws ParentNotInitializedException

Tells if the given element is a direct or indirect parent.

Throws:

ParentNotInitializedException

getPosition

SourcePosition getPosition()

Gets the position of this element in input source files

Returns:

Source file and line number of this element or null

replace

void replace(CtElement element)

Replaces this element by another one.

addAnnotation

boolean addAnnotation(CtAnnotation<? extends Annotation> annotation)

Add an annotation for this element

Parameters:

annotation -

Returns:

true if this element changed as a result of the call

removeAnnotation

boolean removeAnnotation(CtAnnotation<? extends Annotation> annotation)

Remove an annotation for this element

Parameters:

annotation -

Returns:

true if this element changed as a result of the call

setDocComment

void setDocComment(String docComment)

Sets the text of the documentation ("javadoc") comment of this declaration.

setParent

void setParent(CtElement element)

Manually sets the parent element of the current element. Note that the parents of an entire tree of elements can be automatically set by using the updateAllParentsBelow().

Parameters:

element - parent

updateAllParentsBelow

void updateAllParentsBelow()

Calculates and sets all the parents below this element. This function can be called to check and fix parents after manipulating the model.

setPosition

void setPosition(SourcePosition position)

Sets the position in the Java source file. Note that this information is used to feed the line numbers in the generated bytecode if any (which is useful for debugging).

Parameters:

position - of this element in the input source files

getAnnotatedChildren

<E extends CtElement> List<E> getAnnotatedChildren(Class<? extends Annotation> annotationType)

Gets the child elements annotated with the given annotation type's instances.

Type Parameters:

E - the element's type

Parameters:

annotationType - the annotation type

Returns:

all the child elements annotated with an instance of the given annotation type

isImplicit

boolean isImplicit()

Returns true if this element is implicit and automatically added by the Java compiler.

setImplicit

void setImplicit(boolean b)

Sets this element to be implicit (will not be printed).

getReferencedTypes

Set<CtTypeReference<?>> getReferencedTypes()

Calculates and returns the set of all the types referenced by this element (and sub-elements in the AST).

getElements

<E extends CtElement> List<E> getElements(Filter<E> filter)

Parameters:

filter -

Returns:

getReferences

<T extends CtReference> List<T> getReferences(ReferenceFilter<T> filter)

Parameters:

filter -

Returns:

setPositions

void setPositions(SourcePosition position)

Sets the position of this element and all its children element. Note that this information is used to feed the line numbers in the generated bytecode if any (which is useful for debugging).

Parameters:

position - of this element and all children in the input source file

setAnnotations

void setAnnotations(List<CtAnnotation<? extends Annotation>> annotation)

Sets the annotations for this element.