Package spoon.support.reflect.declaration

Class CtTypeImpl<T>

java.lang.Object

spoon.support.reflect.declaration.CtElementImpl

spoon.support.reflect.declaration.CtNamedElementImpl

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

All Implemented Interfaces:

Serializable, Cloneable, FactoryAccessor, SourcePositionHolder, CtElement, CtFormalTypeDeclarer, CtModifiable, CtNamedElement, CtShadowable, CtType<T>, CtTypeInformation, CtTypeMember, CtQueryable, CtVisitable

Direct Known Subclasses:

CtAnnotationTypeImpl, CtClassImpl, CtInterfaceImpl, CtTypeParameterImpl

public abstract class CtTypeImpl<T>
extends CtNamedElementImpl
implements CtType<T>

The implementation for CtType.

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

INNERTTYPE_SEPARATOR, NAME_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CtTypeImpl()

Method Summary

Modifier and Type	Method	Description
<F, C extends CtType<T>> C	addField(int index, CtField<F> field)	add a field at a given position.
<F, C extends CtType<T>> C	addField(CtField<F> field)	add a field at the end of the field list.
<F, C extends CtType<T>> C	addFieldAtTop(CtField<F> field)	Adds a field at the top of the type (before static block).
<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.
<M, C extends CtType<T>> C	addMethod(CtMethod<M> method)	Adds a method to this type.
<C extends CtModifiable> C	addModifier(ModifierKind modifier)	add a modifier
<N, C extends CtType<T>> C	addNestedType(CtType<N> nestedType)	Add a nested type.
<S, C extends CtType<T>> C	addSuperInterface(CtTypeReference<S> interfac)
<C extends CtType<T>> C	addTypeMember(CtTypeMember member)	Adds a type member.
<C extends CtType<T>> C	addTypeMemberAt(int position, CtTypeMember member)	Adds a type member at a given position.
CtType<T>	clone()	Clone the element which calls this method in a new object.
void	compileAndReplaceSnippets()	Replace all the code snippets that are found in this type by the corresponding Spoon AST.
CtType<?>	copyType()	Copy the type, where copy means cloning + porting all the references in the clone from the old type to the new type.
Class<T>	getActualClass()	This is a low-level feature, it should never been used by non advanced users.
Collection<CtExecutableReference<?>>	getAllExecutables()	Gets the executables declared by this type and by all its supertypes (static/instance methods, constructors, anonymous static blocks) if applicable.
List<CtFieldReference<?>>	getAllFields()	Gets the fields declared by this type and by all its supertypes if applicable.
Set<CtMethod<?>>	getAllMethods()	Return all the methods that can be called on an instance of this type.
Collection<CtExecutableReference<?>>	getDeclaredExecutables()	Gets the executables declared by this type if applicable.
CtFieldReference<?>	getDeclaredField(String name)	Gets a field from its name.
List<CtFieldReference<?>>	getDeclaredFields()	Gets the fields declared by this type.
CtFieldReference<?>	getDeclaredOrInheritedField(String fieldName)	Gets a field from this type or any super type or any implemented interface by field name.
CtType<?>	getDeclaringType()	Gets the type that declares this class member.
Set<CtExtendedModifier>	getExtendedModifiers()
CtField<?>	getField(String name)	Gets a field from its name.
List<CtField<?>>	getFields()	Returns the fields that are directly declared by this class or interface.
List<CtTypeParameter>	getFormalCtTypeParameters()	Returns the formal type parameters of this generic element.
<R> CtMethod<R>	getMethod(String name, CtTypeReference<?>... parameterTypes)	Gets a method from its name and parameter types.
<R> CtMethod<R>	getMethod(CtTypeReference<R> returnType, String name, CtTypeReference<?>... parameterTypes)	Gets a method from its return type, name, and parameter types.
Set<CtMethod<?>>	getMethods()	Returns the methods that are directly declared by this class or interface.
Set<CtMethod<?>>	getMethodsAnnotatedWith(CtTypeReference<?>... annotationTypes)	Returns the methods that are directly declared by this class or interface and annotated with one of the given annotations.
List<CtMethod<?>>	getMethodsByName(String name)	Returns the methods that are directly declared by this class or interface and that have the given name.
Set<ModifierKind>	getModifiers()	Gets modifiers of this type.
<N extends CtType<?>> N	getNestedType(String name)	Gets a nested type from its name.
Set<CtType<?>>	getNestedTypes()	Returns the declarations of the nested classes and interfaces that are directly declared by this class or interface.
CtPackage	getPackage()	Gets the package where this type is declared.
String	getQualifiedName()	Returns the fully qualified name of this type declaration.
CtTypeReference<T>	getReference()	Returns the corresponding reference.
CtTypeReference<?>	getSuperclass()	Returns a reference to the type directly extended by this type.
Set<CtTypeReference<?>>	getSuperInterfaces()	Returns the interface types directly implemented by this class or extended by this interface.
<T> CtType<T>	getTopLevelType()	Returns the top level type declaring this type if an inner type or type member.
CtTypeReference<?>	getTypeErasure()	This method returns a reference to the erased type.
List<CtTypeMember>	getTypeMembers()	Gets all type members of the type like fields, methods, anonymous block, etc.
Set<CtTypeReference<?>>	getUsedTypes(boolean includeSamePackage)	Returns the types used by this type.
ModifierKind	getVisibility()	Gets the visibility of this modifiable element.
boolean	hasMethod(CtMethod<?> method)	Searches in the type for the given method.
boolean	hasModifier(ModifierKind modifier)	Tells if this element contains the given modifier.
protected boolean	hasSameParameters(CtExecutable<?> candidate, CtTypeReference<?>... parameterTypes)
boolean	isAbstract()	Returns true if it contains an abstract modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isAnnotationType()	Returns true if this type is an annotation type.
boolean	isAnonymous()	Return true if the referenced type is an anonymous type
boolean	isArray()	Returns true if this type represents an array like Object[] or int[].
boolean	isClass()	Returns true if this type is a class.
boolean	isEnum()	Returns true if this type is an enum.
boolean	isFinal()	Returns true if it contains a final modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isGenerics()	Returns true if it is not a concrete, resolvable class, it if refers to a type parameter directly or indirectly.
boolean	isInterface()	Returns true if this type is an interface.
boolean	isLocalType()	Returns true if the referenced type is declared in an executable.
boolean	isNative()	Returns true if it contains a native modifier (see CtModifiable.hasModifier(ModifierKind))
boolean	isParameterized()	Returns true if it has any type parameter (generic or not).
boolean	isPrimitive()	Checks if the referenced type is a primitive type.
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". 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.
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	isTopLevel()	Returns true if this type is top-level (declared as the main type in a file).
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))
<F> boolean	removeField(CtField<F> field)	remove a Field
boolean	removeFormalCtTypeParameter(CtTypeParameter formalTypeParameter)	Removes a type parameters from this generic element.
<M> boolean	removeMethod(CtMethod<M> method)	Removes a method from this type.
<C extends CtModifiable> C	removeModifier(ModifierKind modifier)	remove a modifier
<N> boolean	removeNestedType(CtType<N> nestedType)	Remove a nested type.
<S> boolean	removeSuperInterface(CtTypeReference<S> interfac)
boolean	removeTypeMember(CtTypeMember member)	Removes the type member.
<T extends CtModifiable> T	setExtendedModifiers(Set<CtExtendedModifier> extendedModifiers)
<C extends CtType<T>> C	setFields(List<CtField<?>> fields)	Sets all fields in the type.
<C extends CtFormalTypeDeclarer> C	setFormalCtTypeParameters(List<CtTypeParameter> formalTypeParameters)	Sets the type parameters of this generic element.
<C extends CtType<T>> C	setMethods(Set<CtMethod<?>> methods)	Sets the methods of this type.
<C extends CtModifiable> C	setModifiers(Set<ModifierKind> modifiers)	Sets the modifiers.
<C extends CtType<T>> C	setNestedTypes(Set<CtType<?>> nestedTypes)	Sets all nested types.
<E extends CtShadowable> E	setShadow(boolean isShadow)	Marks an element as shadow.
<T extends CtNamedElement> T	setSimpleName(String simpleName)	Sets the simple (unqualified) name of this element.
<C extends CtType<T>> C	setSuperclass(CtTypeReference<?> superClass)	Sets the superclass type.
<C extends CtType<T>> C	setSuperInterfaces(Set<CtTypeReference<?>> interfaces)	Sets the super interfaces of this type.
<C extends CtType<T>> C	setTypeMembers(List<CtTypeMember> members)	Removes all types members with these new members.
<C extends CtModifiable> C	setVisibility(ModifierKind visibility)	Sets the visibility of this modifiable element (replaces old visibility).
String	toStringWithImports()	Gets the entire class code with package and imports.

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

getSimpleName

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.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.visitor.chain.CtQueryable

filterChildren, map, map

Methods inherited from interface spoon.reflect.declaration.CtType

getSimpleName

Methods inherited from interface spoon.reflect.declaration.CtTypeInformation

isSubtypeOf

Methods inherited from interface spoon.reflect.visitor.CtVisitable

accept

Methods inherited from interface spoon.processing.FactoryAccessor

getFactory, setFactory

Constructor Details

CtTypeImpl

protected CtTypeImpl()

Method Details

getTypeMembers

public List<CtTypeMember> getTypeMembers()

Description copied from interface: CtType

Gets all type members of the type like fields, methods, anonymous block, etc.

Specified by:

getTypeMembers in interface CtType<T>

addTypeMember

public <C extends CtType<T>> C addTypeMember(CtTypeMember member)

Adds a type member. If it has a position, adds it at the right place according to the position (sourceStart). If it is implicit, adds it at the beginning. Otherwise, adds it at the end.

Specified by:

addTypeMember in interface CtType<T>

addTypeMemberAt

public <C extends CtType<T>> C addTypeMemberAt(int position,
 CtTypeMember member)

Description copied from interface: CtType

Adds a type member at a given position. Think to use this method if the order is important for you.

Specified by:

addTypeMemberAt in interface CtType<T>

removeTypeMember

public boolean removeTypeMember(CtTypeMember member)

Description copied from interface: CtType

Removes the type member.

Specified by:

removeTypeMember in interface CtType<T>

setTypeMembers

public <C extends CtType<T>> C setTypeMembers(List<CtTypeMember> members)

Description copied from interface: CtType

Removes all types members with these new members.

Specified by:

setTypeMembers in interface CtType<T>

addFieldAtTop

public <F,
C extends CtType<T>> C addFieldAtTop(CtField<F> field)

Description copied from interface: CtType

Adds a field at the top of the type (before static block). Note that the position of these field will be negative to be written at the top of the type.

Specified by:

addFieldAtTop in interface CtType<T>

Returns:

true if the field is added.

addField

public <F,
C extends CtType<T>> C addField(CtField<F> field)

Description copied from interface: CtType

add a field at the end of the field list.

Specified by:

addField in interface CtType<T>

Returns:

true if this element changed as a result of the call

addField

public <F,
C extends CtType<T>> C addField(int index,
 CtField<F> field)

Description copied from interface: CtType

add a field at a given position.

Specified by:

addField in interface CtType<T>

Returns:

true if this element changed as a result of the call

setFields

public <C extends CtType<T>> C setFields(List<CtField<?>> fields)

Description copied from interface: CtType

Sets all fields in the type.

Specified by:

setFields in interface CtType<T>

removeField

public <F> boolean removeField(CtField<F> field)

Description copied from interface: CtType

remove a Field

Specified by:

removeField in interface CtType<T>

Returns:

true if this element changed as a result of the call

getField

public CtField<?> getField(String name)

Description copied from interface: CtType

Gets a field from its name.

Specified by:

getField in interface CtType<T>

Returns:

null if does not exit

getDeclaredField

public CtFieldReference<?> getDeclaredField(String name)

Description copied from interface: CtTypeInformation

Gets a field from its name.

Specified by:

getDeclaredField in interface CtTypeInformation

Returns:

a reference to the field with the name or null if it does not exist

getDeclaredOrInheritedField

public CtFieldReference<?> getDeclaredOrInheritedField(String fieldName)

Description copied from interface: CtTypeInformation

Gets a field from this type or any super type or any implemented interface by field name.

Specified by:

getDeclaredOrInheritedField in interface CtTypeInformation

Returns:

a reference to the field with the name or null if it does not exist

getFields

public List<CtField<?>> getFields()

Description copied from interface: CtType

Returns the fields that are directly declared by this class or interface. Includes enum constants. Derived from CtType.getTypeMembers()

Specified by:

getFields in interface CtType<T>

addNestedType

public <N,
C extends CtType<T>> C addNestedType(CtType<N> nestedType)

Description copied from interface: CtType

Add a nested type.

Specified by:

addNestedType in interface CtType<T>

Returns:

true if this element changed as a result of the call

removeNestedType

public <N> boolean removeNestedType(CtType<N> nestedType)

Description copied from interface: CtType

Remove a nested type.

Specified by:

removeNestedType in interface CtType<T>

Returns:

true if this element changed as a result of the call

setNestedTypes

public <C extends CtType<T>> C setNestedTypes(Set<CtType<?>> nestedTypes)

Description copied from interface: CtType

Sets all nested types.

Specified by:

setNestedTypes in interface CtType<T>

getUsedTypes

public Set<CtTypeReference<?>> getUsedTypes(boolean includeSamePackage)

Description copied from interface: CtType

Returns the types used by this type.

Specified by:

getUsedTypes in interface CtType<T>

Parameters:

includeSamePackage - set to true if the method should return also the types located in the same package as the current type

getActualClass

public Class<T> getActualClass()

Description copied from interface: CtType

This is a low-level feature, it should never been used by non advanced users. See full documentation at CtTypeReference.getActualClass().

Specified by:

getActualClass in interface CtType<T>

getDeclaringType

public CtType<?> getDeclaringType()

Description copied from interface: CtTypeMember

Gets the type that declares this class member.

Specified by:

getDeclaringType in interface CtTypeMember

Returns:

declaring class

getTopLevelType

public <T> CtType<T> getTopLevelType()

Description copied from interface: CtTypeMember

Returns the top level type declaring this type if an inner type or type member. If this is already a top-level type, then returns itself.

Specified by:

getTopLevelType in interface CtTypeMember

getNestedType

public <N extends CtType<?>> N getNestedType(String name)

Description copied from interface: CtType

Gets a nested type from its name.

Specified by:

getNestedType in interface CtType<T>

getNestedTypes

public Set<CtType<?>> getNestedTypes()

Description copied from interface: CtType

Returns the declarations of the nested classes and interfaces that are directly declared by this class or interface.

Specified by:

getNestedTypes in interface CtType<T>

getPackage

public CtPackage getPackage()

Description copied from interface: CtType

Gets the package where this type is declared.

Specified by:

getPackage in interface CtType<T>

getReference

public CtTypeReference<T> getReference()

Description copied from interface: CtNamedElement

Returns the corresponding reference.

Specified by:

getReference in interface CtNamedElement

Specified by:

getReference in interface CtType<T>

Overrides:

getReference in class CtNamedElementImpl

Returns:

the corresponding reference

isTopLevel

public boolean isTopLevel()

Description copied from interface: CtType

Returns true if this type is top-level (declared as the main type in a file).

Specified by:

isTopLevel in interface CtType<T>

compileAndReplaceSnippets

public void compileAndReplaceSnippets()

Description copied from interface: CtType

Replace all the code snippets that are found in this type by the corresponding Spoon AST.

Specified by:

compileAndReplaceSnippets in interface CtType<T>

See Also:

• CtCodeSnippet
• CtCodeSnippetExpression
• CtCodeSnippetStatement

getModifiers

public Set<ModifierKind> getModifiers()

Description copied from interface: CtTypeInformation

Gets modifiers of this type.

Specified by:

getModifiers in interface CtModifiable

Specified by:

getModifiers in interface CtTypeInformation

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 <T extends CtModifiable> T setExtendedModifiers(Set<CtExtendedModifier> extendedModifiers)

Specified by:

setExtendedModifiers in interface CtModifiable

isPrimitive

public boolean isPrimitive()

Description copied from interface: CtTypeInformation

Checks if the referenced type is a primitive type.

It is a primitive type, if it is one of the following types:

• byte
• short
• int
• long
• float
• double
• boolean
• char
• void

For boxed types like Integer this method returns false.

Specified by:

isPrimitive in interface CtTypeInformation

Returns:

true if the referenced type is a primitive type

isAnonymous

public boolean isAnonymous()

Description copied from interface: CtTypeInformation

Return true if the referenced type is an anonymous type

Specified by:

isAnonymous in interface CtTypeInformation

isLocalType

public boolean isLocalType()

Description copied from interface: CtTypeInformation

Returns true if the referenced type is declared in an executable. e.g. a type declared in a method or a lambda. This corresponds to isLocalClass of java.lang.Class.

     // Type declared in a method.
     public void make() {
         class Cook {
         }
     }
     // Type declared in a lambda.
     s -> {
         class Cook {
         }
     }
 

Specified by:

isLocalType in interface CtTypeInformation

getSuperclass

public CtTypeReference<?> getSuperclass()

Description copied from interface: CtTypeInformation

Returns a reference to the type directly extended by this type.

To get the CtType of the super class, use CtTypeReference.getDeclaration() or CtTypeReference.getTypeDeclaration() on the CtTypeReference returned by this method.

Specified by:

getSuperclass in interface CtTypeInformation

Returns:

the type explicitly extended by this type, or null if there is none or if the super type is not in the classpath (in noclasspath mode). If a class does not explicitly extend another class null is returned (not Object). For types like enums that implicitly extend a superclass like Enum, this method returns that class.

isClass

public boolean isClass()

Description copied from interface: CtTypeInformation

Returns true if this type is a class. Returns false for others (enum, interface, generics, annotation).

Specified by:

isClass in interface CtTypeInformation

isInterface

public boolean isInterface()

Description copied from interface: CtTypeInformation

Returns true if this type is an interface.

Specified by:

isInterface in interface CtTypeInformation

isAnnotationType

public boolean isAnnotationType()

Description copied from interface: CtTypeInformation

Returns true if this type is an annotation type.

Specified by:

isAnnotationType in interface CtTypeInformation

isEnum

public boolean isEnum()

Description copied from interface: CtTypeInformation

Returns true if this type is an enum.

Specified by:

isEnum in interface CtTypeInformation

isGenerics

public boolean isGenerics()

Description copied from interface: CtTypeInformation

Returns true if it is not a concrete, resolvable class, it if refers to a type parameter directly or indirectly. Direct: "T foo" isGenerics returns true. Indirect: List<T>, or Set<List<T>> isGenerics returns true

Specified by:

isGenerics in interface CtTypeInformation

isParameterized

public boolean isParameterized()

Description copied from interface: CtTypeInformation

Returns true if it has any type parameter (generic or not).

Specified by:

isParameterized in interface CtTypeInformation

getAllFields

public List<CtFieldReference<?>> getAllFields()

Description copied from interface: CtTypeInformation

Gets the fields declared by this type and by all its supertypes if applicable.

Specified by:

getAllFields in interface CtTypeInformation

getDeclaredFields

public List<CtFieldReference<?>> getDeclaredFields()

Description copied from interface: CtTypeInformation

Gets the fields declared by this type.

Specified by:

getDeclaredFields in interface CtTypeInformation

addMethod

public <M,
C extends CtType<T>> C addMethod(CtMethod<M> method)

Description copied from interface: CtType

Adds a method to this type.

Specified by:

addMethod in interface CtType<T>

removeMethod

public <M> boolean removeMethod(CtMethod<M> method)

Description copied from interface: CtType

Removes a method from this type.

Specified by:

removeMethod in interface CtType<T>

addSuperInterface

public <S,
C extends CtType<T>> C addSuperInterface(CtTypeReference<S> interfac)

Specified by:

addSuperInterface in interface CtType<T>

Returns:

true if this element changed as a result of the call

removeSuperInterface

public <S> boolean removeSuperInterface(CtTypeReference<S> interfac)

Specified by:

removeSuperInterface in interface CtType<T>

Returns:

true if this element changed as a result of the call

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

getMethod

public <R> CtMethod<R> getMethod(CtTypeReference<R> returnType,
 String name,
 CtTypeReference<?>... parameterTypes)

Description copied from interface: CtType

Gets a method from its return type, name, and parameter types.

Specified by:

getMethod in interface CtType<T>

Returns:

null if does not exit

getMethod

public <R> CtMethod<R> getMethod(String name,
 CtTypeReference<?>... parameterTypes)

Description copied from interface: CtType

Gets a method from its name and parameter types.

Specified by:

getMethod in interface CtType<T>

Returns:

null if does not exit

hasSameParameters

protected boolean hasSameParameters(CtExecutable<?> candidate,
 CtTypeReference<?>... parameterTypes)

getMethods

public Set<CtMethod<?>> getMethods()

Description copied from interface: CtType

Returns the methods that are directly declared by this class or interface. Derived from CtType.getTypeMembers()

Specified by:

getMethods in interface CtType<T>

getMethodsAnnotatedWith

public Set<CtMethod<?>> getMethodsAnnotatedWith(CtTypeReference<?>... annotationTypes)

Description copied from interface: CtType

Returns the methods that are directly declared by this class or interface and annotated with one of the given annotations.

Specified by:

getMethodsAnnotatedWith in interface CtType<T>

getMethodsByName

public List<CtMethod<?>> getMethodsByName(String name)

Description copied from interface: CtType

Returns the methods that are directly declared by this class or interface and that have the given name.

Specified by:

getMethodsByName in interface CtType<T>

hasMethod

public boolean hasMethod(CtMethod<?> method)

Description copied from interface: CtType

Searches in the type for the given method. Super classes and implemented interfaces are considered. The matching criterion is that the signatures are identical.

Specified by:

hasMethod in interface CtType<T>

Parameters:

method - The method to search for in the class.

Returns:

True: the type has the given method. False otherwise.

setSimpleName

public <T extends CtNamedElement> T setSimpleName(String simpleName)

Description copied from interface: CtNamedElement

Sets the simple (unqualified) name of this element.

Specified by:

setSimpleName in interface CtNamedElement

Overrides:

setSimpleName in class CtNamedElementImpl

getQualifiedName

public String getQualifiedName()

Description copied from interface: CtTypeInformation

Returns the fully qualified name of this type declaration.

Specified by:

getQualifiedName in interface CtTypeInformation

getSuperInterfaces

public Set<CtTypeReference<?>> getSuperInterfaces()

Description copied from interface: CtTypeInformation

Returns the interface types directly implemented by this class or extended by this interface.

Specified by:

getSuperInterfaces in interface CtTypeInformation

setMethods

public <C extends CtType<T>> C setMethods(Set<CtMethod<?>> methods)

Description copied from interface: CtType

Sets the methods of this type.

Specified by:

setMethods in interface CtType<T>

setSuperclass

public <C extends CtType<T>> C setSuperclass(CtTypeReference<?> superClass)

Description copied from interface: CtType

Sets the superclass type.

Specified by:

setSuperclass in interface CtType<T>

setSuperInterfaces

public <C extends CtType<T>> C setSuperInterfaces(Set<CtTypeReference<?>> interfaces)

Description copied from interface: CtType

Sets the super interfaces of this type.

Specified by:

setSuperInterfaces in interface CtType<T>

getDeclaredExecutables

public Collection<CtExecutableReference<?>> getDeclaredExecutables()

Description copied from interface: CtTypeInformation

Gets the executables declared by this type if applicable.

Specified by:

getDeclaredExecutables in interface CtTypeInformation

getAllExecutables

public Collection<CtExecutableReference<?>> getAllExecutables()

Description copied from interface: CtTypeInformation

Gets the executables declared by this type and by all its supertypes (static/instance methods, constructors, anonymous static blocks) if applicable. This method returns:

• static, instance and default methods
• constructors

If a method is overridden twice in the hierarchy, it counts for two different elements. The method can be abstract.

Specified by:

getAllExecutables in interface CtTypeInformation

getAllMethods

public Set<CtMethod<?>> getAllMethods()

Description copied from interface: CtType

Return all the methods that can be called on an instance of this type. It recursively collects all methods (both concrete and abstract) from all super-classes and all super-interfaces. It deduplicates methods with the same signature, which are defined several times somewhere in the type hierarchy. Warning: this method can be really slow due to signature deduplication. It includes all methods: the methods of types whose source code is in the Spoon model, the methods of types from the JDK and from libraries present in the classpath, the methods of java.lang.Object (for all CtClass objects). However, in noclasspath mode, it does not include methods from unknown types. If methods are overridden somewhere in the type hierarchy, it returns only top methods (ie method definitions).

Specified by:

getAllMethods in interface CtType<T>

getTypeErasure

public CtTypeReference<?> getTypeErasure()

Description copied from interface: CtTypeInformation

This method returns a reference to the erased type.

For example, this will return List for List<String>, or Enum for the type parameter E in the enum declaration.

Specified by:

getTypeErasure in interface CtTypeInformation

Returns:

a reference to the erased type

See Also:

• Type Erasure

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 CtType<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 CtNamedElement

Specified by:

clone in interface CtType<T>

Overrides:

clone in class CtNamedElementImpl

Returns:

a clone of this element. All children are cloned, but the parent of the returned clone is set to null.

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

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

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

copyType

public CtType<?> copyType()

Description copied from interface: CtType

Copy the type, where copy means cloning + porting all the references in the clone from the old type to the new type. The copied type is added to the same package (and this to the factory as well). A new unique method name is given for each copy, and this method can be called several times.

Specified by:

copyType in interface CtType<T>

isArray

public boolean isArray()

Description copied from interface: CtTypeInformation

Returns true if this type represents an array like Object[] or int[].

Specified by:

isArray in interface CtTypeInformation

Returns:

true if this type represents an array like Object[] or int[]

toStringWithImports

public String toStringWithImports()

Description copied from interface: CtType

Gets the entire class code with package and imports.

Specified by:

toStringWithImports in interface CtType<T>