org.eclipse.xtext.xbase.typesystem.references

Class ArrayTypeReference

java.lang.Object

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

org.eclipse.xtext.xbase.typesystem.references.ArrayTypeReference

public class ArrayTypeReference
extends LightweightTypeReference

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
ArrayTypeReference(ITypeReferenceOwner owner, LightweightTypeReference component)

Method Summary

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)
protected LightweightTypeReference	doCopyInto(ITypeReferenceOwner owner)
LightweightTypeReference	getComponentType() Returns the component type of the current array type.
java.lang.String	getIdentifier() Returns the identifier of this type reference.
java.lang.String	getJavaIdentifier()
int	getKind() Subclasses must override this method.
LightweightTypeReference	getNamedType() Returns the named type if this is an anonymous type.
LightweightTypeReference	getRawTypeReference()
java.lang.String	getSimpleName() Prints the simple name of this type reference.
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(org.eclipse.xtext.common.types.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)
org.eclipse.xtext.common.types.JvmArrayType	getType()
java.lang.String	getUniqueIdentifier() Returns an identifier that allows to disambiguate type parameter names that have different origins.
boolean	isAnonymous()
boolean	isArray()
boolean	isOwnedBy(ITypeReferenceOwner owner)
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.
boolean	isUnknown()
boolean	isVisible(IVisibilityHelper visibilityHelper) Returns true if this type is fully visible according to the given visibilityHelper.
org.eclipse.xtext.common.types.JvmTypeReference	toJavaCompliantTypeReference(IVisibilityHelper visibilityHelper) Converts this type reference to a JvmTypeReference that can be used in Java source code.
org.eclipse.xtext.common.types.JvmTypeReference	toTypeReference()
ArrayTypeReference	tryConvertToArray() Returns the array representation of this reference if its represents a subtype of Iterable or already an array itself.
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

collectSuperTypes, collectSuperTypes, copyInto, createSubstitutor, expose, findNonNullType, findType, getAllSuperTypes, getAsFunctionTypeReference, getFunctionTypeKind, getHumanReadableName, getInvariantBoundSubstitute, getLowerBoundSubstitute, getMultiTypeComponents, getNonInterfaceTypes, getOuter, getOwner, getPrimitiveIfWrapperType, getPrimitiveKind, getPrimitiveKindIfWrapperType, getRawTypes, getServices, getSuperTypes, getTypeArguments, getTypesFactory, getUniqueIdentifier, getUpperBoundSubstitute, getWrapperTypeIfPrimitive, hasTypeArguments, internalFindTopLevelType, internalIsAssignableFrom, isAny, isAssignableFrom, isAssignableFrom, isAssignableFrom, isAssignableFrom, isFunctionType, isInterfaceType, isMultiType, isPrimitive, isPrimitiveVoid, isSubtypeOf, isSubtypeOf, isSynonym, isValidHint, isWildcard, isWrapper, toJavaCompliantTypeReference, toJavaCompliantTypeReference, toJavaType, toString, tryConvertToFunctionTypeReference

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayTypeReference

public ArrayTypeReference(ITypeReferenceOwner owner,
                          LightweightTypeReference component)

Method Detail

getKind

public int getKind()

Subclasses must override this method.

Overrides:

getKind in class LightweightTypeReference

toTypeReference

public org.eclipse.xtext.common.types.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 org.eclipse.xtext.common.types.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 org.eclipse.xtext.common.types.JvmArrayType getType()

Specified by:

getType in class LightweightTypeReference

isUnknown

public boolean isUnknown()

Overrides:

isUnknown in class LightweightTypeReference

getSuperTypes

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

Specified by:

getSuperTypes in class LightweightTypeReference

getSuperType

public LightweightTypeReference getSuperType(org.eclipse.xtext.common.types.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(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.

isResolved

public boolean isResolved()

Overrides:

isResolved 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

isAnonymous

public boolean isAnonymous()

Overrides:

isAnonymous in class LightweightTypeReference

getNamedType

public LightweightTypeReference getNamedType()

Description copied from class: LightweightTypeReference

Returns the named type if this is an anonymous type.

Overrides:

getNamedType 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

isArray

public boolean isArray()

Overrides:

isArray in class LightweightTypeReference

tryConvertToListType

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.

tryConvertToArray

public ArrayTypeReference tryConvertToArray()

Description copied from class: LightweightTypeReference

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.

doCopyInto

protected LightweightTypeReference doCopyInto(ITypeReferenceOwner owner)

Specified by:

doCopyInto in class LightweightTypeReference

getSimpleName

public java.lang.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 java.lang.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 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

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

getComponentType

public LightweightTypeReference getComponentType()

Description copied from class: LightweightTypeReference

Returns the component type of the current array type. Does not attempt to convert this reference from iterable to array, first.

Overrides:

getComponentType in class LightweightTypeReference

Returns:

the compoent type of the current array or null.

See Also:

LightweightTypeReference.isArray()

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