Package spoon.reflect.factory

Class TypeFactory

java.lang.Object

spoon.reflect.factory.SubFactory

spoon.reflect.factory.TypeFactory

Direct Known Subclasses:

AnnotationFactory, ClassFactory, EnumFactory, InterfaceFactory

public class TypeFactory
extends SubFactory

The CtType sub-factory.

Field Summary

Fields

Modifier and Type	Field	Description
final CtTypeReference<Boolean>	BOOLEAN	Deprecated, for removal: This API element is subject to removal in a future version. Use booleanType() instead.
final CtTypeReference<Boolean>	BOOLEAN_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use booleanPrimitiveType() instead.
final CtTypeReference<Byte>	BYTE	Deprecated, for removal: This API element is subject to removal in a future version. Use byteType() instead.
final CtTypeReference<Byte>	BYTE_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use bytePrimitiveType() instead.
final CtTypeReference<Character>	CHARACTER	Deprecated, for removal: This API element is subject to removal in a future version. Use characterType() instead.
final CtTypeReference<Character>	CHARACTER_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use characterPrimitiveType() instead.
final CtTypeReference<Collection>	COLLECTION	Deprecated, for removal: This API element is subject to removal in a future version. Use TypeFactory#createReference(Collection.class) instead.
final CtTypeReference<Date>	DATE	Deprecated, for removal: This API element is subject to removal in a future version. Use dateType() instead.
final CtTypeReference<Double>	DOUBLE	Deprecated, for removal: This API element is subject to removal in a future version. Use doubleType() instead.
final CtTypeReference<Double>	DOUBLE_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use doublePrimitiveType() instead.
final CtTypeReference<Enum>	ENUM	Deprecated, for removal: This API element is subject to removal in a future version. Use TypeFactory#createReference(Enum.class) instead.
final CtTypeReference<Float>	FLOAT	Deprecated, for removal: This API element is subject to removal in a future version. Use floatType() instead.
final CtTypeReference<Float>	FLOAT_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use floatPrimitiveType() instead.
final CtTypeReference<Integer>	INTEGER	Deprecated, for removal: This API element is subject to removal in a future version. Use integerType() instead.
final CtTypeReference<Integer>	INTEGER_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use integerPrimitiveType() instead.
final CtTypeReference<Iterable>	ITERABLE	Deprecated, for removal: This API element is subject to removal in a future version. Use TypeFactory#createReference(Iterable.class) instead.
final CtTypeReference<List>	LIST	Deprecated, for removal: This API element is subject to removal in a future version. Use TypeFactory#createReference(List.class) instead.
final CtTypeReference<Long>	LONG	Deprecated, for removal: This API element is subject to removal in a future version. Use longType() instead.
final CtTypeReference<Long>	LONG_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use longPrimitiveType() instead.
final CtTypeReference<Map>	MAP	Deprecated, for removal: This API element is subject to removal in a future version. Use TypeFactory#createReference(Map.class) instead.
final CtTypeReference<?>	NULL_TYPE	Deprecated, for removal: This API element is subject to removal in a future version. Use nullType() instead.
final CtTypeReference<Object>	OBJECT	Deprecated, for removal: This API element is subject to removal in a future version. Use objectType() instead.
final CtTypeReference<?>	OMITTED_TYPE_ARG_TYPE	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated for removal without replacement.
final CtTypeReference<Set>	SET	Deprecated, for removal: This API element is subject to removal in a future version. Use TypeFactory#createReference(Set.class) instead.
final CtTypeReference<Short>	SHORT	Deprecated, for removal: This API element is subject to removal in a future version. Use shortType() instead.
final CtTypeReference<Short>	SHORT_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use shortPrimitiveType() instead.
final CtTypeReference<String>	STRING	Deprecated, for removal: This API element is subject to removal in a future version. Use stringType() instead.
final CtTypeReference<Void>	VOID	Deprecated, for removal: This API element is subject to removal in a future version. Use voidType() instead.
final CtTypeReference<Void>	VOID_PRIMITIVE	Deprecated, for removal: This API element is subject to removal in a future version. Use voidPrimitiveType() instead.

Fields inherited from class spoon.reflect.factory.SubFactory

factory

Constructor Summary

Constructors

Constructor	Description
TypeFactory()
TypeFactory(Factory factory)	Creates a new type sub-factory.

Method Summary

Modifier and Type	Method	Description
CtTypeReference<Boolean>	booleanPrimitiveType()	Returns a reference on the boolean primitive type.
CtTypeReference<Boolean>	booleanType()	Returns a reference on the boolean type.
CtTypeReference<Byte>	bytePrimitiveType()	Returns a reference on the byte primitive type.
CtTypeReference<Byte>	byteType()	Returns a reference on the byte type.
CtTypeReference<Character>	characterPrimitiveType()	Returns a reference on the character primitive type.
CtTypeReference<Character>	characterType()	Returns a reference on the character type.
<T> CtArrayTypeReference<T>	createArrayReference(String qualifiedName)	Creates a reference to an array of given type.
<T> CtArrayTypeReference<T[]>	createArrayReference(CtType<T> type)	Creates a reference to an array of given type.
CtArrayTypeReference<?>	createArrayReference(CtTypeReference<?> reference, int n)	Creates a reference to a n-dimension array of given type.
<T> CtArrayTypeReference<T[]>	createArrayReference(CtTypeReference<T> reference)	Creates a reference to a one-dimension array of given type.
CtImport	createImport(CtReference reference)	Creates an import declaration.
<T> CtIntersectionTypeReference<T>	createIntersectionTypeReferenceWithBounds(List<CtTypeReference<?>> bounds)	Creates an intersection type reference.
<T> CtTypeReference<T>	createReference(Class<T> type)
<T> CtTypeReference<T>	createReference(Class<T> type, boolean includingFormalTypeParameter)	Creates a reference to a simple type
<T> CtTypeReference<T>	createReference(String qualifiedName)	Create a reference to a simple type
<T> CtTypeReference<T>	createReference(CtType<T> type)	Create a reference to a simple type
<T> CtTypeReference<T>	createReference(CtType<T> type, boolean includingFormalTypeParameter)
CtTypeParameterReference	createReference(CtTypeParameter type)	Create a reference to a simple type
List<CtTypeReference<?>>	createReferences(List<Class<?>> classes)	Creates a collection of type references from a collection of classes.
<T> CtTypeReference<T>	createSimplyQualifiedReference(String qualifiedName)	Create a reference to a simple type, setting the beginning of its fully qualified name as implicit
GenericTypeAdapter	createTypeAdapter(CtFormalTypeDeclarer formalTypeDeclarer)	Create a GenericTypeAdapter for adapting of formal type parameters from any compatible context to the context of provided `formalTypeDeclarer`
CtTypeMemberWildcardImportReference	createTypeMemberWildcardImportReference(CtTypeReference typeReference)	Create a wildcard reference to a simple type
CtTypeParameterReference	createTypeParameterReference(String name)	Creates a type parameter reference with no bounds.
CtImport	createUnresolvedImport(String reference, boolean isStatic)
CtTypeReference<Date>	dateType()	Returns a reference on the date type.
CtTypeReference<Double>	doublePrimitiveType()	Returns a reference on the double primitive type.
CtTypeReference<Double>	doubleType()	Returns a reference on the double type.
CtTypeReference<Float>	floatPrimitiveType()	Returns a reference on the float primitive type.
CtTypeReference<Float>	floatType()	Returns a reference on the float type.
<T> CtType<T>	get(Class<?> cl)	Gets a type from its runtime Java class.
<T> CtType<T>	get(String qualifiedName)	Gets a created type from its qualified name if source in the source classpath.
List<CtType<?>>	getAll()	Gets the list of all top-level created types.
List<CtType<?>>	getAll(boolean includeNestedTypes)	Gets the list of all created types.
protected String	getDeclaringTypeName(String qualifiedName)	Gets the declaring type name for a given Java qualified name.
CtTypeReference	getDefaultBoundingType()	Returns the default bounding type value
protected String	getPackageName(String qualifiedName)	Gets the package name for a given Java qualified name.
protected String	getSimpleName(String qualifiedName)	Gets the simple name for a given Java qualified name.
protected int	hasInnerType(String qualifiedName)	Tells if a given Java qualified name is that of an inner type.
protected int	hasPackage(String qualifiedName)	Tells if a given Java qualified name contains a package name.
CtTypeReference<Integer>	integerPrimitiveType()	Returns a reference on the integer primitive type.
CtTypeReference<Integer>	integerType()	Returns a reference on the integer type.
CtTypeReference<Long>	longPrimitiveType()	Returns a reference on the long primitive type.
CtTypeReference<Long>	longType()	Returns a reference on the long type.
CtTypeReference<?>	nullType()	Returns a reference on the null type (type of null).
CtTypeReference<Object>	objectType()	Returns a reference on the object type.
CtTypeReference<Short>	shortPrimitiveType()	Returns a reference on the short primitive type.
CtTypeReference<Short>	shortType()	Returns a reference on the short type.
CtTypeReference<String>	stringType()	Returns a reference on the string type.
CtTypeReference<Void>	voidPrimitiveType()	Returns a reference on the void primitive type.
CtTypeReference<Void>	voidType()	Returns a reference on the void type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NULL_TYPE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<?> NULL_TYPE

Deprecated, for removal: This API element is subject to removal in a future version.

Use nullType() instead.

VOID

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Void> VOID

Deprecated, for removal: This API element is subject to removal in a future version.

Use voidType() instead.

STRING

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<String> STRING

Deprecated, for removal: This API element is subject to removal in a future version.

Use stringType() instead.

BOOLEAN

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Boolean> BOOLEAN

Deprecated, for removal: This API element is subject to removal in a future version.

Use booleanType() instead.

BYTE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Byte> BYTE

Deprecated, for removal: This API element is subject to removal in a future version.

Use byteType() instead.

CHARACTER

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Character> CHARACTER

Deprecated, for removal: This API element is subject to removal in a future version.

Use characterType() instead.

INTEGER

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Integer> INTEGER

Deprecated, for removal: This API element is subject to removal in a future version.

Use integerType() instead.

LONG

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Long> LONG

Deprecated, for removal: This API element is subject to removal in a future version.

Use longType() instead.

FLOAT

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Float> FLOAT

Deprecated, for removal: This API element is subject to removal in a future version.

Use floatType() instead.

DOUBLE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Double> DOUBLE

Deprecated, for removal: This API element is subject to removal in a future version.

Use doubleType() instead.

VOID_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Void> VOID_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use voidPrimitiveType() instead.

BOOLEAN_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Boolean> BOOLEAN_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use booleanPrimitiveType() instead.

BYTE_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Byte> BYTE_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use bytePrimitiveType() instead.

CHARACTER_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Character> CHARACTER_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use characterPrimitiveType() instead.

INTEGER_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Integer> INTEGER_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use integerPrimitiveType() instead.

LONG_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Long> LONG_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use longPrimitiveType() instead.

FLOAT_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Float> FLOAT_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use floatPrimitiveType() instead.

DOUBLE_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Double> DOUBLE_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use doublePrimitiveType() instead.

SHORT

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Short> SHORT

Deprecated, for removal: This API element is subject to removal in a future version.

Use shortType() instead.

SHORT_PRIMITIVE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Short> SHORT_PRIMITIVE

Deprecated, for removal: This API element is subject to removal in a future version.

Use shortPrimitiveType() instead.

DATE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Date> DATE

Deprecated, for removal: This API element is subject to removal in a future version.

Use dateType() instead.

OBJECT

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Object> OBJECT

Deprecated, for removal: This API element is subject to removal in a future version.

Use objectType() instead.

ITERABLE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Iterable> ITERABLE

Deprecated, for removal: This API element is subject to removal in a future version.

Use TypeFactory#createReference(Iterable.class) instead.

COLLECTION

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Collection> COLLECTION

Deprecated, for removal: This API element is subject to removal in a future version.

Use TypeFactory#createReference(Collection.class) instead.

LIST

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<List> LIST

Deprecated, for removal: This API element is subject to removal in a future version.

Use TypeFactory#createReference(List.class) instead.

SET

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Set> SET

Deprecated, for removal: This API element is subject to removal in a future version.

Use TypeFactory#createReference(Set.class) instead.

MAP

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Map> MAP

Deprecated, for removal: This API element is subject to removal in a future version.

Use TypeFactory#createReference(Map.class) instead.

ENUM

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<Enum> ENUM

Deprecated, for removal: This API element is subject to removal in a future version.

Use TypeFactory#createReference(Enum.class) instead.

OMITTED_TYPE_ARG_TYPE

@Deprecated(since="11.0.0",
            forRemoval=true)
public final CtTypeReference<?> OMITTED_TYPE_ARG_TYPE

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated for removal without replacement.

Constructor Details

TypeFactory

public TypeFactory(Factory factory)

Creates a new type sub-factory.

Parameters:

factory - the parent factory

TypeFactory

public TypeFactory()

Method Details

nullType

public CtTypeReference<?> nullType()

Returns a reference on the null type (type of null).

voidType

public CtTypeReference<Void> voidType()

Returns a reference on the void type.

voidPrimitiveType

public CtTypeReference<Void> voidPrimitiveType()

Returns a reference on the void primitive type.

stringType

public CtTypeReference<String> stringType()

Returns a reference on the string type.

booleanType

public CtTypeReference<Boolean> booleanType()

Returns a reference on the boolean type.

booleanPrimitiveType

public CtTypeReference<Boolean> booleanPrimitiveType()

Returns a reference on the boolean primitive type.

byteType

public CtTypeReference<Byte> byteType()

Returns a reference on the byte type.

bytePrimitiveType

public CtTypeReference<Byte> bytePrimitiveType()

Returns a reference on the byte primitive type.

characterType

public CtTypeReference<Character> characterType()

Returns a reference on the character type.

characterPrimitiveType

public CtTypeReference<Character> characterPrimitiveType()

Returns a reference on the character primitive type.

integerType

public CtTypeReference<Integer> integerType()

Returns a reference on the integer type.

integerPrimitiveType

public CtTypeReference<Integer> integerPrimitiveType()

Returns a reference on the integer primitive type.

longType

public CtTypeReference<Long> longType()

Returns a reference on the long type.

longPrimitiveType

public CtTypeReference<Long> longPrimitiveType()

Returns a reference on the long primitive type.

floatType

public CtTypeReference<Float> floatType()

Returns a reference on the float type.

floatPrimitiveType

public CtTypeReference<Float> floatPrimitiveType()

Returns a reference on the float primitive type.

doubleType

public CtTypeReference<Double> doubleType()

Returns a reference on the double type.

doublePrimitiveType

public CtTypeReference<Double> doublePrimitiveType()

Returns a reference on the double primitive type.

shortType

public CtTypeReference<Short> shortType()

Returns a reference on the short type.

shortPrimitiveType

public CtTypeReference<Short> shortPrimitiveType()

Returns a reference on the short primitive type.

dateType

public CtTypeReference<Date> dateType()

Returns a reference on the date type.

objectType

public CtTypeReference<Object> objectType()

Returns a reference on the object type.

createArrayReference

public <T> CtArrayTypeReference<T[]> createArrayReference(CtType<T> type)

Creates a reference to an array of given type.

Type Parameters:

T - type of array

Parameters:

type - type of array values

createArrayReference

public <T> CtArrayTypeReference<T[]> createArrayReference(CtTypeReference<T> reference)

Creates a reference to a one-dimension array of given type.

createArrayReference

public CtArrayTypeReference<?> createArrayReference(CtTypeReference<?> reference,
 int n)

Creates a reference to a n-dimension array of given type.

createArrayReference

public <T> CtArrayTypeReference<T> createArrayReference(String qualifiedName)

Creates a reference to an array of given type.

createReference

public <T> CtTypeReference<T> createReference(Class<T> type)

createReference

public <T> CtTypeReference<T> createReference(Class<T> type,
 boolean includingFormalTypeParameter)

Creates a reference to a simple type

createReference

public <T> CtTypeReference<T> createReference(CtType<T> type)

Create a reference to a simple type

createTypeMemberWildcardImportReference

public CtTypeMemberWildcardImportReference createTypeMemberWildcardImportReference(CtTypeReference typeReference)

Create a wildcard reference to a simple type

createReference

public <T> CtTypeReference<T> createReference(CtType<T> type,
 boolean includingFormalTypeParameter)

Parameters:

includingFormalTypeParameter - if true then references to formal type parameters are added as actual type arguments of returned CtTypeReference

createReference

public CtTypeParameterReference createReference(CtTypeParameter type)

Create a reference to a simple type

createReference

public <T> CtTypeReference<T> createReference(String qualifiedName)

Create a reference to a simple type

createSimplyQualifiedReference

public <T> CtTypeReference<T> createSimplyQualifiedReference(String qualifiedName)

Create a reference to a simple type, setting the beginning of its fully qualified name as implicit

get

public <T> CtType<T> get(String qualifiedName)

Gets a created type from its qualified name if source in the source classpath. `TypeFactory#get(String)` returns null if the class is not in the source classpath (even if it is in the binary classpath). `TypeFactory#get(Class)` returns null if the class is neither in the source classpath nor in the binary classpath, and returns a [shadow class](http://spoon.gforge.inria.fr/reflection.html) if it is only in the binary classpath. Note that a shadow class has empty method bodies, if you need a shadow class with method bodies, see [spoon-decompiler](https://github.com/INRIA/spoon/tree/master/spoon-decompiler))

Returns:

a type if source in the source classpath or null if does not exist

getAll

public List<CtType<?>> getAll()

Gets the list of all top-level created types.

getAll

public List<CtType<?>> getAll(boolean includeNestedTypes)

Gets the list of all created types.

get

public <T> CtType<T> get(Class<?> cl)

Gets a type from its runtime Java class. If the class isn't in the spoon path, the class will be built from the Java reflection and will be marked as shadow (see CtShadowable).

Type Parameters:

T - actual type of the class

Parameters:

cl - the java class: note that this class should be Class<T> but it then poses problem when T is a generic type itself

getDeclaringTypeName

protected String getDeclaringTypeName(String qualifiedName)

Gets the declaring type name for a given Java qualified name.

createReferences

public List<CtTypeReference<?>> createReferences(List<Class<?>> classes)

Creates a collection of type references from a collection of classes.

getPackageName

protected String getPackageName(String qualifiedName)

Gets the package name for a given Java qualified name.

getSimpleName

protected String getSimpleName(String qualifiedName)

Gets the simple name for a given Java qualified name.

hasInnerType

protected int hasInnerType(String qualifiedName)

Tells if a given Java qualified name is that of an inner type.

hasPackage

protected int hasPackage(String qualifiedName)

Tells if a given Java qualified name contains a package name.

createTypeParameterReference

public CtTypeParameterReference createTypeParameterReference(String name)

Creates a type parameter reference with no bounds.

Parameters:

name - the name of the formal parameter

createTypeAdapter

public GenericTypeAdapter createTypeAdapter(CtFormalTypeDeclarer formalTypeDeclarer)

Create a GenericTypeAdapter for adapting of formal type parameters from any compatible context to the context of provided `formalTypeDeclarer`

Parameters:

formalTypeDeclarer - the target scope of the returned GenericTypeAdapter

createIntersectionTypeReferenceWithBounds

public <T> CtIntersectionTypeReference<T> createIntersectionTypeReferenceWithBounds(List<CtTypeReference<?>> bounds)

Creates an intersection type reference.

Type Parameters:

T - Type of the first bound.

Parameters:

bounds - List of bounds saved in the intersection type. The first bound will be the intersection type.

getDefaultBoundingType

public CtTypeReference getDefaultBoundingType()

Returns the default bounding type value

createImport

public CtImport createImport(CtReference reference)

Creates an import declaration.

createUnresolvedImport

public CtImport createUnresolvedImport(String reference,
 boolean isStatic)