org.eclipse.xtext.xbase.typesystem.references

Class CompoundTypeReference

java.lang.Object

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

org.eclipse.xtext.xbase.typesystem.references.CompoundTypeReference

public class CompoundTypeReference
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 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_INNER_FUNCTION_TYPE_REFERENCE, KIND_INNER_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
CompoundTypeReference(ITypeReferenceOwner owner, boolean synonym)

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	addComponent(LightweightTypeReference component)
protected LightweightTypeReference	doCopyInto(ITypeReferenceOwner owner)
FunctionTypeKind	getFunctionTypeKind()
String	getIdentifier() Returns the identifier of this type reference.
String	getJavaIdentifier()
int	getKind() Subclasses must override this method.
List<LightweightTypeReference>	getMultiTypeComponents()
LightweightTypeReference	getRawTypeReference()
String	getSimpleName() Prints the simple name of this type reference.
LightweightTypeReference	getSuperType(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 List<LightweightTypeReference>	getSuperTypes(TypeParameterSubstitutor<?> substitutor)
JvmType	getType()
List<LightweightTypeReference>	getTypeArguments() Returns the type arguments of this reference if it has any.
String	getUniqueIdentifier() Returns an identifier that allows to disambiguate type parameter names that have different origins.
boolean	isAnonymous()
boolean	isAny()
boolean	isArray()
boolean	isInterfaceType()
boolean	isMultiType()
boolean	isOwnedBy(ITypeReferenceOwner owner)
boolean	isPrimitive()
boolean	isPrimitiveVoid()
boolean	isRawType() Returns true is this type points to a raw type.
boolean	isResolved()
boolean	isSynonym()
boolean	isType(Class<?> clazz) Returns true if this type reference represents an type with the given raw type clazz.
boolean	isVisible(IVisibilityHelper visibilityHelper) Returns true if this type is fully visible according to the given visibilityHelper.
boolean	isWrapper()
JvmTypeReference	toJavaCompliantTypeReference(IVisibilityHelper visibilityHelper) Converts this type reference to a JvmTypeReference that can be used in Java source code.
LightweightTypeReference	toJavaType() Converts types to references that can be expressed as Java type references in source code.
JvmTypeReference	toTypeReference()

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

collectSuperTypes, collectSuperTypes, copyInto, createSubstitutor, expose, findNonNullType, findType, getAllSuperTypes, getAsFunctionTypeReference, getComponentType, getHumanReadableName, getInvariantBoundSubstitute, getLowerBoundSubstitute, getNamedType, getNonInterfaceTypes, getOuter, getOwner, getPrimitiveIfWrapperType, getPrimitiveKind, getPrimitiveKindIfWrapperType, getRawTypes, getServices, getSuperTypes, getTypesFactory, getUniqueIdentifier, getUpperBoundSubstitute, getWrapperTypeIfPrimitive, hasTypeArguments, internalFindTopLevelType, internalIsAssignableFrom, isAssignableFrom, isAssignableFrom, isAssignableFrom, isAssignableFrom, isFunctionType, isSubtypeOf, isSubtypeOf, isUnknown, isValidHint, isWildcard, toJavaCompliantTypeReference, toJavaCompliantTypeReference, toString, tryConvertToArray, tryConvertToFunctionTypeReference, tryConvertToListType

Methods inherited from class java.lang.Object

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

Constructor Detail

CompoundTypeReference

public CompoundTypeReference(ITypeReferenceOwner owner,
                     boolean synonym)

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

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)

Converts this type reference to a JvmTypeReference that can be used in Java source code. If this is a multi-type rather than a synonym, the Java compliant type reference is determined from the common super type of all participating, non-interface types. If there is no such type or this is a synonym, all the component types are used to compute the common super type and use that one as the type.

Specified by:

toJavaCompliantTypeReference in class LightweightTypeReference

getTypeArguments

public 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

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

isArray

public boolean isArray()

Overrides:

isArray in class LightweightTypeReference

isAny

public boolean isAny()

Overrides:

isAny in class LightweightTypeReference

isPrimitive

public boolean isPrimitive()

Overrides:

isPrimitive in class LightweightTypeReference

isAnonymous

public boolean isAnonymous()

Overrides:

isAnonymous in class LightweightTypeReference

isWrapper

public boolean isWrapper()

Overrides:

isWrapper in class LightweightTypeReference

isPrimitiveVoid

public boolean isPrimitiveVoid()

Overrides:

isPrimitiveVoid in class LightweightTypeReference

getFunctionTypeKind

public FunctionTypeKind getFunctionTypeKind()

Overrides:

getFunctionTypeKind in class LightweightTypeReference

isInterfaceType

public boolean isInterfaceType()

Overrides:

isInterfaceType in class LightweightTypeReference

getRawTypeReference

public LightweightTypeReference getRawTypeReference()

Overrides:

getRawTypeReference in class LightweightTypeReference

Returns:

the erasure type of this type reference

isOwnedBy

public boolean isOwnedBy(ITypeReferenceOwner owner)

Overrides:

isOwnedBy in class LightweightTypeReference

getType

public JvmType getType()

Specified by:

getType in class LightweightTypeReference

getSuperTypes

protected List<LightweightTypeReference> getSuperTypes(TypeParameterSubstitutor<?> substitutor)

Specified by:

getSuperTypes in class LightweightTypeReference

getSuperType

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.

getSuperType

public LightweightTypeReference getSuperType(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.

isType

public boolean isType(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

doCopyInto

protected LightweightTypeReference doCopyInto(ITypeReferenceOwner owner)

Specified by:

doCopyInto in class LightweightTypeReference

isResolved

public boolean isResolved()

Overrides:

isResolved in class LightweightTypeReference

isSynonym

public boolean isSynonym()

Overrides:

isSynonym in class LightweightTypeReference

addComponent

public void addComponent(LightweightTypeReference component)

getSimpleName

public String getSimpleName()

Description copied from class: LightweightTypeReference

Prints the simple name of this type reference. Useful for testing.

Specified by:

getSimpleName in class LightweightTypeReference

getIdentifier

public String getIdentifier()

Description copied from class: LightweightTypeReference

Returns the identifier of this type reference. Usually the qualified name with a dollar delimiter.

Specified by:

getIdentifier in class LightweightTypeReference

getUniqueIdentifier

public 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 String getJavaIdentifier()

Specified by:

getJavaIdentifier 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

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

Overrides:

accept in class LightweightTypeReference

accept

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

Overrides:

accept in class LightweightTypeReference

isMultiType

public boolean isMultiType()

Overrides:

isMultiType in class LightweightTypeReference

toJavaType

public LightweightTypeReference toJavaType()

Description copied from class: LightweightTypeReference

Converts types to references that can be expressed as Java type references in source code. Any types will be expressed as Object whereas multi types will be expressed as their common super type. Unknown types are considered to be ok thus returned as is.

Overrides:

toJavaType in class LightweightTypeReference

getMultiTypeComponents

public List<LightweightTypeReference> getMultiTypeComponents()

Overrides:

getMultiTypeComponents in class LightweightTypeReference