Package spoon.support.reflect.declaration

Class CtMethodImpl<T>

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.declaration.CtNamedElementImpl

spoon.support.reflect.declaration.CtExecutableImpl<T>

spoon.support.reflect.declaration.CtMethodImpl<T>

All Implemented Interfaces:

Serializable, Cloneable, FactoryAccessor, CtBodyHolder, SourcePositionHolder, CtElement, CtExecutable<T>, CtFormalTypeDeclarer, CtMethod<T>, CtModifiable, CtNamedElement, CtShadowable, CtTypedElement<T>, CtTypeMember, CtQueryable, CtVisitable

Direct Known Subclasses:

CtAnnotationMethodImpl

public class CtMethodImpl<T>
extends CtExecutableImpl<T>
implements CtMethod<T>

The implementation for CtMethod.

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

Fields inherited from interface spoon.reflect.declaration.CtExecutable

EXECUTABLE_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
CtMethodImpl()

Method Summary

Modifier and Type	Method	Description
void	accept(CtVisitor v)	Accepts a visitor
<C extends CtFormalTypeDeclarer> C	addFormalCtTypeParameter(CtTypeParameter formalTypeParameter)	Add a type parameter to this generic element.
<C extends CtFormalTypeDeclarer> C	addFormalCtTypeParameterAt(int position, CtTypeParameter formalTypeParameter)	Add a type parameter at a specific position.
<C extends CtModifiable> C	addModifier(ModifierKind modifier)	add a modifier
CtMethod<T>	clone()	Clone the element which calls this method in a new object.
CtMethod<?>	copyMethod()	Copy the method, where copy means cloning + porting all the references of the old method to the new method (important for recursive methods).
Set<CtExtendedModifier>	getExtendedModifiers()
List<CtTypeParameter>	getFormalCtTypeParameters()	Returns the formal type parameters of this generic element.
Set<ModifierKind>	getModifiers()	Returns the modifiers of this element, excluding annotations.
Collection<CtMethod<?>>	getTopDefinitions()	Returns the top-most methods in the hierarchy defining this method (in super class and super interfaces).
CtTypeReference<T>	getType()	Gets this element's type.
ModifierKind	getVisibility()	Gets the visibility of this modifiable element.
boolean	hasModifier(ModifierKind modifier)	Tells if this element contains the given modifier.
boolean	isAbstract()	Returns true if it contains an abstract modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isDefaultMethod()	Checks if the method is a default method.
boolean	isFinal()	Returns true if it contains a final modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isNative()	Returns true if it contains a native modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isOverriding(CtMethod<?> superMethod)
boolean	isPrivate()	Returns true if it contains a private modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isProtected()	Returns true if it contains a protected modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isPublic()	Returns true if it contains a public modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isShadow()	When an element isn't present in the factory (created in another factory), this element is considered as "shadow".
boolean	isStatic()	Returns true if it contains a static modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isStrictfp()	Returns true if it contains a strictfp modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isSynchronized()	Returns true if it contains a synchronized modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isTransient()	Returns true if it contains a transient modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isVolatile()	Returns true if it contains a volatile modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	removeFormalCtTypeParameter(CtTypeParameter formalTypeParameter)	Removes a type parameters from this generic element.
<C extends CtModifiable> C	removeModifier(ModifierKind modifier)	remove a modifier
<C extends CtMethod<T>> C	setDefaultMethod(boolean defaultMethod)	Sets the default value state of a method.
<C extends CtModifiable> C	setExtendedModifiers(Set<CtExtendedModifier> extendedModifiers)
<C extends CtFormalTypeDeclarer> C	setFormalCtTypeParameters(List<CtTypeParameter> formalTypeParameters)	Sets the type parameters of this generic element.
<C extends CtModifiable> C	setModifiers(Set<ModifierKind> modifiers)	Sets the modifiers.
<E extends CtShadowable> E	setShadow(boolean isShadow)	Marks an element as shadow.
<C extends CtTypedElement> C	setType(CtTypeReference type)	Sets this element's type.
<C extends CtModifiable> C	setVisibility(ModifierKind visibility)	Sets the visibility of this modifiable element (replaces old visibility).

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

addParameter, addParameterAt, addThrownType, getBody, getDeclaringType, getParameters, getReference, getSignature, getThrownTypes, getTopLevelType, removeParameter, removeThrownType, setBody, setParameters, setThrownTypes

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

getSimpleName, setSimpleName

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.CtBodyHolder

setBody

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.declaration.CtExecutable

addParameter, addParameterAt, addThrownType, getBody, getParameters, getReference, getSignature, getThrownTypes, removeParameter, removeThrownType, setParameters, setThrownTypes

Methods inherited from interface spoon.reflect.declaration.CtNamedElement

getSimpleName, setSimpleName

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

filterChildren, map, map

Methods inherited from interface spoon.reflect.declaration.CtTypeMember

getDeclaringType, getTopLevelType

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Constructor Detail

CtMethodImpl

public CtMethodImpl()

Method Detail

accept

public void accept(CtVisitor v)

Description copied from interface: CtVisitable

Accepts a visitor

Specified by:

accept in interface CtVisitable

getType

public CtTypeReference<T> getType()

Description copied from interface: CtTypedElement

Gets this element's type.

Specified by:

getType in interface CtTypedElement<T>

setType

public <C extends CtTypedElement> C setType(CtTypeReference type)

Description copied from interface: CtTypedElement

Sets this element's type.

Specified by:

setType in interface CtTypedElement<T>

isDefaultMethod

public boolean isDefaultMethod()

Description copied from interface: CtMethod

Checks if the method is a default method. Default method can be in interfaces from Java 8: http://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html.

Specified by:

isDefaultMethod in interface CtMethod<T>

setDefaultMethod

public <C extends CtMethod<T>> C setDefaultMethod(boolean defaultMethod)

Description copied from interface: CtMethod

Sets the default value state of a method.

Specified by:

setDefaultMethod in interface CtMethod<T>

getFormalCtTypeParameters

public List<CtTypeParameter> getFormalCtTypeParameters()

Description copied from interface: CtFormalTypeDeclarer

Returns the formal type parameters of this generic element.

Specified by:

getFormalCtTypeParameters in interface CtFormalTypeDeclarer

setFormalCtTypeParameters

public <C extends CtFormalTypeDeclarer> C setFormalCtTypeParameters(List<CtTypeParameter> formalTypeParameters)

Description copied from interface: CtFormalTypeDeclarer

Sets the type parameters of this generic element.

Specified by:

setFormalCtTypeParameters in interface CtFormalTypeDeclarer

addFormalCtTypeParameterAt

public <C extends CtFormalTypeDeclarer> C addFormalCtTypeParameterAt(int position,
                                                                     CtTypeParameter formalTypeParameter)

Description copied from interface: CtFormalTypeDeclarer

Add a type parameter at a specific position.

Specified by:

addFormalCtTypeParameterAt in interface CtFormalTypeDeclarer

Parameters:

position - Position to insert the type parameter at

formalTypeParameter - The type parameter to insert

Returns:

The receiver

addFormalCtTypeParameter

public <C extends CtFormalTypeDeclarer> C addFormalCtTypeParameter(CtTypeParameter formalTypeParameter)

Description copied from interface: CtFormalTypeDeclarer

Add a type parameter to this generic element.

Specified by:

addFormalCtTypeParameter in interface CtFormalTypeDeclarer

removeFormalCtTypeParameter

public boolean removeFormalCtTypeParameter(CtTypeParameter formalTypeParameter)

Description copied from interface: CtFormalTypeDeclarer

Removes a type parameters from this generic element.

Specified by:

removeFormalCtTypeParameter in interface CtFormalTypeDeclarer

getModifiers

public Set<ModifierKind> getModifiers()

Description copied from interface: CtModifiable

Returns the modifiers of this element, excluding annotations. Implicit modifiers, such as the public and static modifiers of interface members, are included.

Specified by:

getModifiers in interface CtModifiable

Returns:

the modifiers of this declaration in undefined order; an empty set if there are none

hasModifier

public boolean hasModifier(ModifierKind modifier)

Description copied from interface: CtModifiable

Tells if this element contains the given modifier.

Specified by:

hasModifier in interface CtModifiable

Parameters:

modifier - to search

Returns:

true if this element contain the modifier

setModifiers

public <C extends CtModifiable> C setModifiers(Set<ModifierKind> modifiers)

Description copied from interface: CtModifiable

Sets the modifiers.

Specified by:

setModifiers in interface CtModifiable

addModifier

public <C extends CtModifiable> C addModifier(ModifierKind modifier)

Description copied from interface: CtModifiable

add a modifier

Specified by:

addModifier in interface CtModifiable

removeModifier

public <C extends CtModifiable> C removeModifier(ModifierKind modifier)

Description copied from interface: CtModifiable

remove a modifier

Specified by:

removeModifier in interface CtModifiable

setVisibility

public <C extends CtModifiable> C setVisibility(ModifierKind visibility)

Description copied from interface: CtModifiable

Sets the visibility of this modifiable element (replaces old visibility).

Specified by:

setVisibility in interface CtModifiable

getVisibility

public ModifierKind getVisibility()

Description copied from interface: CtModifiable

Gets the visibility of this modifiable element.

Specified by:

getVisibility in interface CtModifiable

getExtendedModifiers

public Set<CtExtendedModifier> getExtendedModifiers()

Specified by:

getExtendedModifiers in interface CtModifiable

Returns:

the set of extended modifiers (those incl. implicit).

setExtendedModifiers

public <C extends CtModifiable> C setExtendedModifiers(Set<CtExtendedModifier> extendedModifiers)

Specified by:

setExtendedModifiers in interface CtModifiable

isOverriding

public boolean isOverriding(CtMethod<?> superMethod)

Specified by:

isOverriding in interface CtMethod<T>

Parameters:

superMethod - to be checked method

Returns:

true if this method overrides `superMethod`.
Returns true for itself too.

 assertTrue(this.isOverriding(this))
 

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 CtMethod<T> 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 CtElement

Specified by:

clone in interface CtExecutable<T>

Specified by:

clone in interface CtMethod<T>

Specified by:

clone in interface CtNamedElement

Overrides:

clone in class CtExecutableImpl<T>

getTopDefinitions

public Collection<CtMethod<?>> getTopDefinitions()

Description copied from interface: CtMethod

Returns the top-most methods in the hierarchy defining this method (in super class and super interfaces). Returns the empty collection if defined here for the first time.

Specified by:

getTopDefinitions in interface CtMethod<T>

isPublic

public boolean isPublic()

Description copied from interface: CtModifiable

Returns true if it contains a public modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isPublic in interface CtModifiable

isPrivate

public boolean isPrivate()

Description copied from interface: CtModifiable

Returns true if it contains a private modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isPrivate in interface CtModifiable

isProtected

public boolean isProtected()

Description copied from interface: CtModifiable

Returns true if it contains a protected modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isProtected in interface CtModifiable

isFinal

public boolean isFinal()

Description copied from interface: CtModifiable

Returns true if it contains a final modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isFinal in interface CtModifiable

isStatic

public boolean isStatic()

Description copied from interface: CtModifiable

Returns true if it contains a static modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isStatic in interface CtModifiable

isAbstract

public boolean isAbstract()

Description copied from interface: CtModifiable

Returns true if it contains an abstract modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isAbstract in interface CtModifiable

isTransient

public boolean isTransient()

Description copied from interface: CtModifiable

Returns true if it contains a transient modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isTransient in interface CtModifiable

isVolatile

public boolean isVolatile()

Description copied from interface: CtModifiable

Returns true if it contains a volatile modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isVolatile in interface CtModifiable

isSynchronized

public boolean isSynchronized()

Description copied from interface: CtModifiable

Returns true if it contains a synchronized modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isSynchronized in interface CtModifiable

isNative

public boolean isNative()

Description copied from interface: CtModifiable

Returns true if it contains a native modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isNative in interface CtModifiable

isStrictfp

public boolean isStrictfp()

Description copied from interface: CtModifiable

Returns true if it contains a strictfp modifier (see CtModifiable.hasModifier(ModifierKind))

Specified by:

isStrictfp in interface CtModifiable

copyMethod

public CtMethod<?> copyMethod()

Description copied from interface: CtMethod

Copy the method, where copy means cloning + porting all the references of the old method to the new method (important for recursive methods). The copied method is added to the type, with a suffix "Copy". A new unique method name is given for each copy, and this method can be called several times. If you want to rename the new method, use Refactoring.changeMethodName(CtMethod, String) (and not CtNamedElement.setSimpleName(String), which does not update the references)

Specified by:

copyMethod in interface CtMethod<T>