com.github.javaparser.symbolsolver.model.typesystem

Class ReferenceType

java.lang.Object

com.github.javaparser.symbolsolver.model.typesystem.ReferenceType

All Implemented Interfaces:

TypeParameterValueProvider, TypeParametrized, Type

public abstract class ReferenceType
extends Object
implements Type, TypeParametrized, TypeParameterValueProvider

A ReferenceType like a class, an interface or an enum. Note that this type can contain also the values specified for the type parameters.

Author:

Federico Tomassetti

Field Summary

Fields

Modifier and Type	Field and Description
protected TypeDeclaration	typeDeclaration
protected TypeParametersMap	typeParametersMap
protected TypeSolver	typeSolver

Constructor Summary

Constructors

Constructor and Description
ReferenceType(TypeDeclaration typeDeclaration, List<Type> typeParameters, TypeSolver typeSolver)
ReferenceType(TypeDeclaration typeDeclaration, TypeSolver typeSolver)

Method Summary

Modifier and Type	Method and Description
ReferenceType	asReferenceType()
protected boolean	compareConsideringTypeParameters(ReferenceType other)
protected abstract ReferenceType	create(TypeDeclaration typeDeclaration, List<Type> typeParameters, TypeSolver typeSolver)
protected ReferenceType	create(TypeDeclaration typeDeclaration, TypeParametersMap typeParametersMap, TypeSolver typeSolver)
protected abstract ReferenceType	create(TypeDeclaration typeDeclaration, TypeSolver typeSolver)
ReferenceType	deriveTypeParameters(TypeParametersMap typeParametersMap)
String	describe()
boolean	equals(Object o)
List<ReferenceType>	getAllAncestors() Return all ancestors, that means all superclasses and interfaces.
List<ReferenceType>	getAllInterfacesAncestors()
abstract Set<MethodUsage>	getDeclaredMethods() Methods declared on this type.
Optional<Type>	getFieldType(String name) The type of the field could be different from the one in the corresponding FieldDeclaration because type variables would be solved.
Optional<Type>	getGenericParameterByName(String name) Get the type associated with the type parameter with the given name.
String	getId() Id of the declaration.
String	getQualifiedName() Qualified name of the declaration.
TypeDeclaration	getTypeDeclaration() Corresponding TypeDeclaration
List<javaslang.Tuple2<TypeParameterDeclaration,Type>>	getTypeParametersMap() Get the values for all type parameters declared on this type.
int	hashCode()
boolean	hasName() Has the TypeDeclaration a name? Anonymous classes do not have one.
abstract boolean	isAssignableBy(Type other) This method checks if ThisType t = new OtherType() would compile.
protected boolean	isCorrespondingBoxingType(String typeName)
boolean	isRawType()
boolean	isReferenceType() Can this be seen as a ReferenceTypeUsage? In other words: is this a reference to a class, an interface or an enum?
Type	replaceTypeVariables(TypeParameterDeclaration tpToReplace, Type replaced, Map<TypeParameterDeclaration,Type> inferredTypes) Replace all variables referring to the given TypeParameter with the given value.
String	toString()
Type	transformTypeParameters(TypeTransformer transformer) Execute a transformation on all the type parameters of this element.
TypeParametersMap	typeParametersMap()
List<Type>	typeParametersValues() Get the values for all type parameters declared on this type.
Optional<Type>	typeParamValue(TypeParameterDeclaration typeParameterDeclaration) Calculate the value for the given type parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.symbolsolver.model.typesystem.Type

arrayLevel, asArrayType, asPrimitive, asTypeParameter, asWildcard, isArray, isNull, isPrimitive, isReference, isTypeVariable, isVoid, isWildcard, replaceTypeVariables

Methods inherited from interface com.github.javaparser.symbolsolver.model.typesystem.parametrization.TypeParameterValueProvider

useThisTypeParametersOnTheGivenType

Field Detail

typeDeclaration

protected TypeDeclaration typeDeclaration

typeSolver

protected TypeSolver typeSolver

typeParametersMap

protected TypeParametersMap typeParametersMap

Constructor Detail

ReferenceType

public ReferenceType(TypeDeclaration typeDeclaration,
                     TypeSolver typeSolver)

ReferenceType

public ReferenceType(TypeDeclaration typeDeclaration,
                     List<Type> typeParameters,
                     TypeSolver typeSolver)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

isReferenceType

public final boolean isReferenceType()

Description copied from interface: Type

Can this be seen as a ReferenceTypeUsage? In other words: is this a reference to a class, an interface or an enum?

Specified by:

isReferenceType in interface Type

asReferenceType

public ReferenceType asReferenceType()

Specified by:

asReferenceType in interface Type

describe

public String describe()

Specified by:

describe in interface Type

transformTypeParameters

public Type transformTypeParameters(TypeTransformer transformer)

Execute a transformation on all the type parameters of this element.

replaceTypeVariables

public Type replaceTypeVariables(TypeParameterDeclaration tpToReplace,
                                 Type replaced,
                                 Map<TypeParameterDeclaration,Type> inferredTypes)

Description copied from interface: Type

Replace all variables referring to the given TypeParameter with the given value. By replacing these values I could also infer some type equivalence. Those would be collected in the given map.

Specified by:

replaceTypeVariables in interface Type

isAssignableBy

public abstract boolean isAssignableBy(Type other)

This method checks if ThisType t = new OtherType() would compile.

Specified by:

isAssignableBy in interface Type

getAllAncestors

public List<ReferenceType> getAllAncestors()

Return all ancestors, that means all superclasses and interfaces. This list should always include Object (unless this is a reference to Object). The type typeParametersValues should be expressed in terms of this type typeParametersValues.

For example, given:

class Foo<A, B> {} class Bar<C> extends Foo<C, String> {}

a call to getAllAncestors on a reference to Bar having type parameter Boolean should include Foo<Boolean, String>.

getAllInterfacesAncestors

public List<ReferenceType> getAllInterfacesAncestors()

getGenericParameterByName

public Optional<Type> getGenericParameterByName(String name)

Get the type associated with the type parameter with the given name. It returns Optional.empty unless the type declaration declares a type parameter with the given name.

Specified by:

getGenericParameterByName in interface TypeParameterValueProvider

typeParametersValues

public List<Type> typeParametersValues()

Get the values for all type parameters declared on this type. The list can be empty for raw types.

getTypeParametersMap

public List<javaslang.Tuple2<TypeParameterDeclaration,Type>> getTypeParametersMap()

Get the values for all type parameters declared on this type. In case of raw types the values correspond to TypeVariables.

typeParametersMap

public TypeParametersMap typeParametersMap()

Specified by:

typeParametersMap in interface TypeParametrized

getTypeDeclaration

public final TypeDeclaration getTypeDeclaration()

Corresponding TypeDeclaration

getFieldType

public Optional<Type> getFieldType(String name)

The type of the field could be different from the one in the corresponding FieldDeclaration because type variables would be solved.

hasName

public boolean hasName()

Has the TypeDeclaration a name? Anonymous classes do not have one.

getQualifiedName

public String getQualifiedName()

Qualified name of the declaration.

getId

public String getId()

Id of the declaration. It corresponds to the qualified name, unless for local classes.

getDeclaredMethods

public abstract Set<MethodUsage> getDeclaredMethods()

Methods declared on this type.

isRawType

public boolean isRawType()

typeParamValue

public Optional<Type> typeParamValue(TypeParameterDeclaration typeParameterDeclaration)

Description copied from interface: TypeParameterValueProvider

Calculate the value for the given type parameter. It could be inherited.

Specified by:

typeParamValue in interface TypeParameterValueProvider

create

protected abstract ReferenceType create(TypeDeclaration typeDeclaration,
                                        List<Type> typeParameters,
                                        TypeSolver typeSolver)

create

protected ReferenceType create(TypeDeclaration typeDeclaration,
                               TypeParametersMap typeParametersMap,
                               TypeSolver typeSolver)

create

protected abstract ReferenceType create(TypeDeclaration typeDeclaration,
                                        TypeSolver typeSolver)

isCorrespondingBoxingType

protected boolean isCorrespondingBoxingType(String typeName)

compareConsideringTypeParameters

protected boolean compareConsideringTypeParameters(ReferenceType other)

deriveTypeParameters

public ReferenceType deriveTypeParameters(TypeParametersMap typeParametersMap)