org.eclipse.xtext.xbase.typesystem.references

Class ParameterizedTypeReference

java.lang.Object

org.eclipse.xtext.xbase.typesystem.references.LightweightTypeReference

org.eclipse.xtext.xbase.typesystem.references.ParameterizedTypeReference

Direct Known Subclasses:

FunctionTypeReference

@NonNullByDefault
public class ParameterizedTypeReference
extends LightweightTypeReference

Author:

Sebastian Zarnekow - Initial contribution and API

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.xtext.xbase.typesystem.references.LightweightTypeReference

LightweightTypeReference.IdentifierFunction, LightweightTypeReference.JavaIdentifierFunction, LightweightTypeReference.SimpleNameFunction, LightweightTypeReference.UniqueIdentifierFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	resolved

Fields inherited from class org.eclipse.xtext.xbase.typesystem.references.LightweightTypeReference

KIND_ANY_TYPE_REFERENCE, KIND_ARRAY_TYPE_REFERENCE, KIND_COMPOUND_TYPE_REFERENCE, KIND_FUNCTION_TYPE_REFERENCE, KIND_LIGHTWEIGHT_TYPE_REFERENCE, KIND_PARAMETERIZED_TYPE_REFERENCE, KIND_UNBOUND_TYPE_REFERENCE, KIND_UNKNOWN_TYPE_REFERENCE, KIND_WILDCARD_TYPE_REFERENCE

Constructor Summary

Constructors

Constructor and Description
ParameterizedTypeReference(ITypeReferenceOwner owner, JvmType type)

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(TypeReferenceVisitor visitor)
<Param> void	accept(TypeReferenceVisitorWithParameter<Param> visitor, Param param)
<Param,Result> Result	accept(TypeReferenceVisitorWithParameterAndResult<Param,Result> visitor, Param param)
<Result> Result	accept(TypeReferenceVisitorWithResult<Result> visitor)
void	addTypeArgument(LightweightTypeReference argument)
protected void	copyTypeArguments(ParameterizedTypeReference result, ITypeReferenceOwner owner)
protected ParameterizedTypeReference	doCopyInto(ITypeReferenceOwner owner)
FunctionTypeReference	getAsFunctionTypeReference() Returns the equivalent FunctionTypeReference if this reference points to a function or procedure or if it is already a function type reference.
protected java.lang.String	getAsString(java.lang.String type, com.google.common.base.Function<LightweightTypeReference,java.lang.String> format)
FunctionTypeKind	getFunctionTypeKind()
java.lang.String	getIdentifier()
java.lang.String	getJavaIdentifier()
int	getKind() Subclasses must override this method.
LightweightTypeReference	getPrimitiveIfWrapperType()
Primitives.Primitive	getPrimitiveKind()
Primitives.Primitive	getPrimitiveKindIfWrapperType()
LightweightTypeReference	getRawSuperType(JvmType rawType)
LightweightTypeReference	getRawTypeReference()
java.util.List<JvmType>	getRawTypes()
java.lang.String	getSimpleName()
LightweightTypeReference	getSuperType(java.lang.Class<?> rawType) Returns the resolved super type for the given raw type or null if the raw type is not a valid super type of this type.
LightweightTypeReference	getSuperType(JvmType rawType) Returns the resolved super type for the given raw type or null if the raw type is not a valid super type of this type.
protected java.util.List<LightweightTypeReference>	getSuperTypes(TypeParameterSubstitutor<?> substitutor)
JvmType	getType()
java.util.List<LightweightTypeReference>	getTypeArguments() Returns the type arguments of this reference if it has any.
java.lang.String	getUniqueIdentifier() Returns an identifier that allows to disambiguate type parameter names that have different origins.
LightweightTypeReference	getWrapperTypeIfPrimitive()
boolean	isInterfaceType()
boolean	isOwnedBy(ITypeReferenceOwner owner)
boolean	isPrimitive()
boolean	isPrimitiveVoid()
boolean	isRawType() Returns true is this type points to a raw type.
boolean	isResolved()
boolean	isType(java.lang.Class<?> clazz) Returns true if this type reference represents an type with the given raw type clazz.
protected boolean	isTypeVisible(IVisibilityHelper visibilityHelper)
boolean	isVisible(IVisibilityHelper visibilityHelper) Returns true if this type is fully visible according to the given visibilityHelper.
boolean	isWrapper()
ParameterizedTypeReference	toInstanceTypeReference() Returns a projection of this type to the instance level.
JvmTypeReference	toJavaCompliantTypeReference(IVisibilityHelper visibilityHelper) Converts this type reference to a JvmTypeReference that can be used in Java source code.
JvmTypeReference	toTypeReference()
ArrayTypeReference	tryConvertToArray() Returns the array representation of this reference if its represents a subtype of Iterable or already an array itself.
FunctionTypeReference	tryConvertToFunctionTypeReference(boolean rawType) Converts this reference to a FunctionTypeReference if the referenced type is a SAM type.
LightweightTypeReference	tryConvertToListType() Returns the list representation of this reference if it represents an array or is already a subtype of List.

Methods inherited from class org.eclipse.xtext.xbase.typesystem.references.LightweightTypeReference

accept, accept, collectSuperTypes, collectSuperTypes, copyInto, createSubstitutor, expose, findNonNullType, findType, getAllSuperTypes, getComponentType, getInvariantBoundSubstitute, getLowerBoundSubstitute, getMultiTypeComponents, getNonInterfaceTypes, getOwner, getServices, getSuperTypes, getTypesFactory, getUniqueIdentifier, getUpperBoundSubstitute, internalFindTopLevelType, internalIsAssignableFrom, isAny, isArray, isAssignableFrom, isAssignableFrom, isAssignableFrom, isAssignableFrom, isFunctionType, isMultiType, isSubtypeOf, isSubtypeOf, isSynonym, isUnknown, isValidHint, isWildcard, toJavaCompliantTypeReference, toJavaCompliantTypeReference, toJavaType, toMultiType, toString

Methods inherited from class java.lang.Object

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

Field Detail

resolved

protected boolean resolved

Constructor Detail

ParameterizedTypeReference

public ParameterizedTypeReference(ITypeReferenceOwner owner,
                          JvmType type)

Method Detail

getKind

public int getKind()

Subclasses must override this method.

Overrides:

getKind in class LightweightTypeReference

toTypeReference

public JvmTypeReference toTypeReference()

Specified by:

toTypeReference in class LightweightTypeReference

getRawTypeReference

public LightweightTypeReference getRawTypeReference()

Overrides:

getRawTypeReference in class LightweightTypeReference

getRawTypes

public java.util.List<JvmType> getRawTypes()

Overrides:

getRawTypes in class LightweightTypeReference

isTypeVisible

protected boolean isTypeVisible(IVisibilityHelper visibilityHelper)

isVisible

public boolean isVisible(IVisibilityHelper visibilityHelper)

Description copied from class: LightweightTypeReference

Returns true if this type is fully visible according to the given visibilityHelper. All components and bounds are taken into account, e.g. arrays use their component type and generified types check their type arguments, too.

Specified by:

isVisible in class LightweightTypeReference

toJavaCompliantTypeReference

public JvmTypeReference toJavaCompliantTypeReference(IVisibilityHelper visibilityHelper)

Description copied from class: LightweightTypeReference

Converts this type reference to a JvmTypeReference that can be used in Java source code.

Specified by:

toJavaCompliantTypeReference in class LightweightTypeReference

getType

public JvmType getType()

Specified by:

getType in class LightweightTypeReference

isRawType

public boolean isRawType()

Description copied from class: LightweightTypeReference

Returns true is this type points to a raw type. That is, it points to a parameterized type but does not define type arguments or it points to an external type parameter that has a raw type constraint. Type parameters that are declared by the current owner are not considered to be raw types. A type is also a raw type if it inherits from a raw type.

Overrides:

isRawType in class LightweightTypeReference

isOwnedBy

public boolean isOwnedBy(ITypeReferenceOwner owner)

Overrides:

isOwnedBy in class LightweightTypeReference

getWrapperTypeIfPrimitive

public LightweightTypeReference getWrapperTypeIfPrimitive()

Overrides:

getWrapperTypeIfPrimitive in class LightweightTypeReference

getPrimitiveIfWrapperType

public LightweightTypeReference getPrimitiveIfWrapperType()

Overrides:

getPrimitiveIfWrapperType in class LightweightTypeReference

isPrimitive

public boolean isPrimitive()

Overrides:

isPrimitive in class LightweightTypeReference

getPrimitiveKind

@Nullable
public Primitives.Primitive getPrimitiveKind()

Overrides:

getPrimitiveKind in class LightweightTypeReference

getPrimitiveKindIfWrapperType

@Nullable
public Primitives.Primitive getPrimitiveKindIfWrapperType()

Overrides:

getPrimitiveKindIfWrapperType in class LightweightTypeReference

isPrimitiveVoid

public boolean isPrimitiveVoid()

Overrides:

isPrimitiveVoid in class LightweightTypeReference

isInterfaceType

public boolean isInterfaceType()

Overrides:

isInterfaceType in class LightweightTypeReference

isWrapper

public boolean isWrapper()

Overrides:

isWrapper in class LightweightTypeReference

getSuperTypes

protected java.util.List<LightweightTypeReference> getSuperTypes(TypeParameterSubstitutor<?> substitutor)

Specified by:

getSuperTypes in class LightweightTypeReference

getSuperType

@Nullable
public LightweightTypeReference getSuperType(java.lang.Class<?> rawType)

Description copied from class: LightweightTypeReference

Returns the resolved super type for the given raw type or null if the raw type is not a valid super type of this type.

Overrides:

getSuperType in class LightweightTypeReference

Parameters:

rawType - the raw type that should be resolved.

Returns:

the resolved super type.

getSuperType

@Nullable
public LightweightTypeReference getSuperType(JvmType rawType)

Description copied from class: LightweightTypeReference

Returns the resolved super type for the given raw type or null if the raw type is not a valid super type of this type.

Overrides:

getSuperType in class LightweightTypeReference

Parameters:

rawType - the raw type that should be resolved.

Returns:

the resolved super type.

getRawSuperType

@Nullable
public LightweightTypeReference getRawSuperType(JvmType rawType)

getTypeArguments

public java.util.List<LightweightTypeReference> getTypeArguments()

Description copied from class: LightweightTypeReference

Returns the type arguments of this reference if it has any. The type argument of List<String> is String. is also the type argument of a wildcard reference with upper bound ? extends List<String>. Raw types don't carry type arguments. Wildcards with more than one upper bound don't carry type arguments.

Overrides:

getTypeArguments in class LightweightTypeReference

doCopyInto

protected ParameterizedTypeReference doCopyInto(ITypeReferenceOwner owner)

Specified by:

doCopyInto in class LightweightTypeReference

copyTypeArguments

protected void copyTypeArguments(ParameterizedTypeReference result,
                     ITypeReferenceOwner owner)

isResolved

public boolean isResolved()

Overrides:

isResolved in class LightweightTypeReference

addTypeArgument

public void addTypeArgument(LightweightTypeReference argument)

getSimpleName

public java.lang.String getSimpleName()

Specified by:

getSimpleName in class LightweightTypeReference

getIdentifier

public java.lang.String getIdentifier()

Specified by:

getIdentifier in class LightweightTypeReference

getUniqueIdentifier

public java.lang.String getUniqueIdentifier()

Description copied from class: LightweightTypeReference

Returns an identifier that allows to disambiguate type parameter names that have different origins. Rather than just giving the name of the type parameter, it also prints the declarator.

Specified by:

getUniqueIdentifier in class LightweightTypeReference

getJavaIdentifier

public java.lang.String getJavaIdentifier()

Specified by:

getJavaIdentifier in class LightweightTypeReference

getAsString

protected java.lang.String getAsString(java.lang.String type,
                           com.google.common.base.Function<LightweightTypeReference,java.lang.String> format)

isType

public boolean isType(java.lang.Class<?> clazz)

Description copied from class: LightweightTypeReference

Returns true if this type reference represents an type with the given raw type clazz. Returns false if this is not exactly the given type, but a sub type, a super type or a completely unrelated type.

Specified by:

isType in class LightweightTypeReference

accept

public void accept(TypeReferenceVisitor visitor)

Overrides:

accept in class LightweightTypeReference

accept

public <Param> void accept(TypeReferenceVisitorWithParameter<Param> visitor,
                  Param param)

Overrides:

accept in class LightweightTypeReference

accept

@Nullable
public <Result> Result accept(TypeReferenceVisitorWithResult<Result> visitor)

Overrides:

accept in class LightweightTypeReference

accept

@Nullable
public <Param,Result> Result accept(TypeReferenceVisitorWithParameterAndResult<Param,Result> visitor,
                                    Param param)

Overrides:

accept in class LightweightTypeReference

getFunctionTypeKind

public FunctionTypeKind getFunctionTypeKind()

Overrides:

getFunctionTypeKind in class LightweightTypeReference

getAsFunctionTypeReference

@Nullable
public FunctionTypeReference getAsFunctionTypeReference()

Returns the equivalent FunctionTypeReference if this reference points to a function or procedure or if it is already a function type reference. Otherwise returns null.

Overrides:

getAsFunctionTypeReference in class LightweightTypeReference

See Also:

FunctionTypes.getAsFunctionTypeReference(ParameterizedTypeReference)

tryConvertToFunctionTypeReference

@Nullable
public FunctionTypeReference tryConvertToFunctionTypeReference(boolean rawType)

Converts this reference to a FunctionTypeReference if the referenced type is a SAM type. Returns null if this reference does not point to a valid function type.

Overrides:

tryConvertToFunctionTypeReference in class LightweightTypeReference

Parameters:

rawType - if a raw view on the function type is sufficient.

See Also:

FunctionTypes.tryConvertToFunctionTypeReference(ParameterizedTypeReference, boolean)

tryConvertToArray

@Nullable
public ArrayTypeReference tryConvertToArray()

Returns the array representation of this reference if its represents a subtype of Iterable or already an array itself. If the iterable's type is a primitive wrapper, the array is not the primitive array but the wrapper array. May return null if the conversion is not possible.

Overrides:

tryConvertToArray in class LightweightTypeReference

Returns:

an equivalent ArrayTypeReference or null.

See Also:

ArrayTypes.tryConvertToArray(ParameterizedTypeReference)

tryConvertToListType

@Nullable
public LightweightTypeReference tryConvertToListType()

Description copied from class: LightweightTypeReference

Returns the list representation of this reference if it represents an array or is already a subtype of List. If the array's type is a primitive, the list's element type is the wrapper. May return null if the conversion is not possible.

Overrides:

tryConvertToListType in class LightweightTypeReference

Returns:

an equivalent list type or null.

toInstanceTypeReference

public ParameterizedTypeReference toInstanceTypeReference()

Returns a projection of this type to the instance level. That is, type arguments will be replaced by their invariant bounds. The instance projection of ArrayList<? extends Iterable<? extends String>> is ArrayList<Iterable<? extends String>> since it is possible to create instances of ArrayList<Iterable<? extends String>>.