org.eclipse.xtext.xbase.typesystem.references

Class WildcardTypeReference

java.lang.Object

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

org.eclipse.xtext.xbase.typesystem.references.WildcardTypeReference

public class WildcardTypeReference
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
WildcardTypeReference(ITypeReferenceOwner owner)

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	addUpperBound(LightweightTypeReference upperBound)
protected WildcardTypeReference	doCopyInto(ITypeReferenceOwner owner)
String	getIdentifier() Returns the identifier of this type reference.
LightweightTypeReference	getInvariantBoundSubstitute()
String	getJavaIdentifier()
int	getKind() Subclasses must override this method.
LightweightTypeReference	getLowerBound()
LightweightTypeReference	getLowerBoundSubstitute()
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.
List<LightweightTypeReference>	getUpperBounds()
LightweightTypeReference	getUpperBoundSubstitute()
boolean	hasTypeArguments()
boolean	isOwnedBy(ITypeReferenceOwner owner)
boolean	isResolved()
boolean	isType(Class<?> clazz) Returns true if this type reference represents an type with the given raw type clazz.
boolean	isUnbounded() Returns true if this wilcard is unbounded according to http://docs.oracle.com/javase/specs/jls/se7/html/jls-4.html#jls-4.5.1.
boolean	isVisible(IVisibilityHelper visibilityHelper) Returns true if this type is fully visible according to the given visibilityHelper.
boolean	isWildcard()
void	setLowerBound(LightweightTypeReference lowerBound)
JvmTypeReference	toJavaCompliantTypeReference(IVisibilityHelper helper) Converts this type reference to a JvmTypeReference that can be used in Java 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, getFunctionTypeKind, getHumanReadableName, getMultiTypeComponents, getNamedType, getNonInterfaceTypes, getOuter, getOwner, getPrimitiveIfWrapperType, getPrimitiveKind, getPrimitiveKindIfWrapperType, getRawTypeReference, getRawTypes, getServices, getSuperTypes, getTypesFactory, getUniqueIdentifier, getWrapperTypeIfPrimitive, internalFindTopLevelType, internalIsAssignableFrom, isAnonymous, isAny, isArray, isAssignableFrom, isAssignableFrom, isAssignableFrom, isAssignableFrom, isFunctionType, isInterfaceType, isMultiType, isPrimitive, isPrimitiveVoid, isRawType, isSubtypeOf, isSubtypeOf, isSynonym, isUnknown, isValidHint, isWrapper, toJavaCompliantTypeReference, toJavaCompliantTypeReference, toJavaType, toString, tryConvertToArray, tryConvertToFunctionTypeReference, tryConvertToListType

Methods inherited from class java.lang.Object

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

Constructor Detail

WildcardTypeReference

public WildcardTypeReference(ITypeReferenceOwner owner)

Method Detail

getKind

public int getKind()

Subclasses must override this method.

Overrides:

getKind in class LightweightTypeReference

isResolved

public boolean isResolved()

Overrides:

isResolved 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

hasTypeArguments

public boolean hasTypeArguments()

Overrides:

hasTypeArguments in class LightweightTypeReference

getUpperBounds

public List<LightweightTypeReference> getUpperBounds()

isUnbounded

public boolean isUnbounded()

Returns true if this wilcard is unbounded according to http://docs.oracle.com/javase/specs/jls/se7/html/jls-4.html#jls-4.5.1. Unbounded wildcards do not have any upper or lower bound defined. Unbounded references are only useful on the source level since at runtime an unbound wildcard type gets Object as upper bound (see WildcardType.getUpperBounds().

getLowerBound

public LightweightTypeReference getLowerBound()

isOwnedBy

public boolean isOwnedBy(ITypeReferenceOwner owner)

Overrides:

isOwnedBy in class LightweightTypeReference

doCopyInto

protected WildcardTypeReference doCopyInto(ITypeReferenceOwner owner)

Specified by:

doCopyInto in class LightweightTypeReference

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

getUpperBoundSubstitute

public LightweightTypeReference getUpperBoundSubstitute()

Overrides:

getUpperBoundSubstitute in class LightweightTypeReference

getLowerBoundSubstitute

public LightweightTypeReference getLowerBoundSubstitute()

Overrides:

getLowerBoundSubstitute in class LightweightTypeReference

getInvariantBoundSubstitute

public LightweightTypeReference getInvariantBoundSubstitute()

Overrides:

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

toTypeReference

public JvmTypeReference toTypeReference()

Specified by:

toTypeReference in class LightweightTypeReference

toJavaCompliantTypeReference

public JvmTypeReference toJavaCompliantTypeReference(IVisibilityHelper helper)

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

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

addUpperBound

public void addUpperBound(LightweightTypeReference upperBound)

setLowerBound

public void setLowerBound(LightweightTypeReference lowerBound)

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

getType

public JvmType getType()

Specified by:

getType 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

isWildcard

public boolean isWildcard()

Overrides:

isWildcard in class LightweightTypeReference