org.eclipse.xtext.xbase.typesystem.references

Class StandardTypeReferenceOwner

java.lang.Object

org.eclipse.xtext.xbase.typesystem.references.StandardTypeReferenceOwner

All Implemented Interfaces:

ITypeReferenceOwner

Direct Known Subclasses:

ResolvedTypes.Owner, StandardTypeReferenceOwner

public class StandardTypeReferenceOwner
extends Object
implements ITypeReferenceOwner

Plain instantiable implementation of the ITypeReferenceOwner. It is not capable of handling reference resolution or unbound type argument hints.

Author:

Sebastian Zarnekow - Initial contribution and API

Constructor Summary

Constructors

Constructor and Description
StandardTypeReferenceOwner(CommonTypeComputationServices services, org.eclipse.emf.ecore.EObject context)
StandardTypeReferenceOwner(CommonTypeComputationServices services, org.eclipse.emf.ecore.resource.Resource context)
StandardTypeReferenceOwner(CommonTypeComputationServices services, org.eclipse.emf.ecore.resource.ResourceSet context)

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptHint(Object handle, LightweightBoundTypeArgument boundTypeArgument)
List<LightweightBoundTypeArgument>	getAllHints(Object handle)
org.eclipse.emf.ecore.resource.ResourceSet	getContextResourceSet() Returns the context resource set if any.
List<JvmTypeParameter>	getDeclaredTypeParameters() The currently known type parameters, e.g. the ones that should not be substituted.
LightweightTypeReferenceFactory	getFactory()
CommonTypeComputationServices	getServices() Access to commonly used services for type references.
boolean	isResolved(Object handle)
AnyTypeReference	newAnyTypeReference() Creates a new representation of the any type, e.g. the type of the value null.
ArrayTypeReference	newArrayTypeReference(LightweightTypeReference componentTypeReference) Creates a new ArrayTypeReference with the given component type.
CompoundTypeReference	newCompoundTypeReference(boolean synonym) Creates a new CompoundTypeReference that is either a synonym or a multi type reference.
FunctionTypeReference	newFunctionTypeReference(JvmType type) Creates a new FunctionTypeReference that is backed by the given type.
InnerFunctionTypeReference	newFunctionTypeReference(LightweightTypeReference outer, JvmType type) Create a new InnerFunctionTypeReference that is backed by the given type and has to defined outer type.
ParameterizedTypeReference	newParameterizedTypeReference(JvmType type) Creates a new ParameterizedTypeReference from the given type.
InnerTypeReference	newParameterizedTypeReference(LightweightTypeReference outer, JvmType type) Creates a new InnerTypeReference.
LightweightTypeReference	newReferenceTo(Class<?> type) Creates a references to the given class or returns an UnknownTypeReference if no JRE is available.
LightweightTypeReference	newReferenceTo(Class<?> type, TypeReferenceInitializer<? super ParameterizedTypeReference> init) Creates a references to the given class or returns an UnknownTypeReference if no JRE is available.
LightweightTypeReference	newReferenceToObject() Creates a references to Object or returns an UnknownTypeReference if no JRE is available.
UnknownTypeReference	newUnknownTypeReference() Creates a new unnamed UnknownTypeReference.
UnknownTypeReference	newUnknownTypeReference(String name) Creates a new named UnknownTypeReference.
WildcardTypeReference	newWildcardExtendsObject() Creates a wildcard reference to Object or returns a wildcard to an UnknownTypeReference if no JRE is available.
WildcardTypeReference	newWildcardTypeReference() Creates a new WildcardTypeReference without any upper or lower bounds.
void	setFactory(LightweightTypeReferenceFactory factory)
LightweightTypeReference	toLightweightTypeReference(JvmType type) Creates a new type reference that points to the given type.
LightweightTypeReference	toLightweightTypeReference(JvmTypeReference type) Transforms the given EMF based type reference to its equivalent in the LightweightTypeReference hierarchy.
LightweightTypeReference	toPlainTypeReference(JvmType type) Creates a new type reference that points to the given type.

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardTypeReferenceOwner

public StandardTypeReferenceOwner(CommonTypeComputationServices services,
                          org.eclipse.emf.ecore.resource.ResourceSet context)

StandardTypeReferenceOwner

public StandardTypeReferenceOwner(CommonTypeComputationServices services,
                          org.eclipse.emf.ecore.EObject context)

StandardTypeReferenceOwner

public StandardTypeReferenceOwner(CommonTypeComputationServices services,
                          org.eclipse.emf.ecore.resource.Resource context)

Method Detail

getServices

public CommonTypeComputationServices getServices()

Description copied from interface: ITypeReferenceOwner

Access to commonly used services for type references.

Specified by:

getServices in interface ITypeReferenceOwner

getFactory

public LightweightTypeReferenceFactory getFactory()

setFactory

public void setFactory(LightweightTypeReferenceFactory factory)

getContextResourceSet

public org.eclipse.emf.ecore.resource.ResourceSet getContextResourceSet()

Returns the context resource set if any.

Specified by:

getContextResourceSet in interface ITypeReferenceOwner

acceptHint

public void acceptHint(Object handle,
              LightweightBoundTypeArgument boundTypeArgument)

Specified by:

acceptHint in interface ITypeReferenceOwner

Throws:

UnsupportedOperationException - always

getAllHints

public List<LightweightBoundTypeArgument> getAllHints(Object handle)

Specified by:

getAllHints in interface ITypeReferenceOwner

Throws:

UnsupportedOperationException - always

isResolved

public boolean isResolved(Object handle)

Specified by:

isResolved in interface ITypeReferenceOwner

Throws:

UnsupportedOperationException - always

getDeclaredTypeParameters

public List<JvmTypeParameter> getDeclaredTypeParameters()

Description copied from interface: ITypeReferenceOwner

The currently known type parameters, e.g. the ones that should not be substituted.

Specified by:

getDeclaredTypeParameters in interface ITypeReferenceOwner

Returns:

the empty list

toPlainTypeReference

public LightweightTypeReference toPlainTypeReference(JvmType type)

Description copied from interface: ITypeReferenceOwner

Creates a new type reference that points to the given type. If the type is a JvmArrayType, an ArrayTypeReference is produced. The produced LightweightTypeReference does not have any type arguments. It is similar to a raw type reference except for cases where the type points to a JvmTypeParameter or an array of type parameters. In those cases, the result is different form toPlainTypeReference(JvmType). getRawTypeReference().

Specified by:

toPlainTypeReference in interface ITypeReferenceOwner

Parameters:

type - the type. May not be null.

toLightweightTypeReference

public LightweightTypeReference toLightweightTypeReference(JvmType type)

Description copied from interface: ITypeReferenceOwner

Creates a new type reference that points to the given type. If the type is a JvmArrayType, an ArrayTypeReference is produced. The produced LightweightTypeReference does have type arguments if the given type is generic or an array of a generic type. The type arguments point to the original type parameters. Useful for later substitution of all type parameters.

Specified by:

toLightweightTypeReference in interface ITypeReferenceOwner

Parameters:

type - the raw type. May not be null.

toLightweightTypeReference

public LightweightTypeReference toLightweightTypeReference(JvmTypeReference type)

Description copied from interface: ITypeReferenceOwner

Transforms the given EMF based type reference to its equivalent in the LightweightTypeReference hierarchy.

Specified by:

toLightweightTypeReference in interface ITypeReferenceOwner

Parameters:

type - the type to convert. May not be null.

newCompoundTypeReference

public CompoundTypeReference newCompoundTypeReference(boolean synonym)

Description copied from interface: ITypeReferenceOwner

Creates a new CompoundTypeReference that is either a synonym or a multi type reference.

Specified by:

newCompoundTypeReference in interface ITypeReferenceOwner

Parameters:

synonym - whether it should be a synonym type reference.

newWildcardTypeReference

public WildcardTypeReference newWildcardTypeReference()

Description copied from interface: ITypeReferenceOwner

Creates a new WildcardTypeReference without any upper or lower bounds. Usually clients need to add those to make it a valid type reference.

Specified by:

newWildcardTypeReference in interface ITypeReferenceOwner

newArrayTypeReference

public ArrayTypeReference newArrayTypeReference(LightweightTypeReference componentTypeReference)

Description copied from interface: ITypeReferenceOwner

Creates a new ArrayTypeReference with the given component type.

Specified by:

newArrayTypeReference in interface ITypeReferenceOwner

newFunctionTypeReference

public FunctionTypeReference newFunctionTypeReference(JvmType type)

Description copied from interface: ITypeReferenceOwner

Creates a new FunctionTypeReference that is backed by the given type. Constraints apply as in ITypeReferenceOwner.newParameterizedTypeReference(JvmType). Clients are responsible to pass a valid SAM type to ITypeReferenceOwner.newFunctionTypeReference(JvmType).

Specified by:

newFunctionTypeReference in interface ITypeReferenceOwner

Parameters:

type - the raw function type.

newFunctionTypeReference

public InnerFunctionTypeReference newFunctionTypeReference(LightweightTypeReference outer,
                                                  JvmType type)

Description copied from interface: ITypeReferenceOwner

Create a new InnerFunctionTypeReference that is backed by the given type and has to defined outer type. Constraints apply as in ITypeReferenceOwner.newFunctionTypeReference(JvmType) and ITypeReferenceOwner.newParameterizedTypeReference(LightweightTypeReference, JvmType).

Specified by:

newFunctionTypeReference in interface ITypeReferenceOwner

Parameters:

outer - the outer type reference.

type - the raw type for the newly produced ParameterizedTypeReference

newParameterizedTypeReference

public ParameterizedTypeReference newParameterizedTypeReference(JvmType type)

Description copied from interface: ITypeReferenceOwner

Creates a new ParameterizedTypeReference from the given type. The type may either be a JvmTypeParameter, JvmPrimitiveType, JvmDeclaredType or JvmVoid. Other types are considered invalid and will cause an IllegalArgumentException to be thrown. If the type is a non-static nested type, the produced type reference will be an InnerTypeReference. The produced type reference does not have any type arguments. If the given type is generic, the returned type reference is a raw type.

Specified by:

newParameterizedTypeReference in interface ITypeReferenceOwner

Parameters:

type - the raw type for the newly produced ParameterizedTypeReference

newParameterizedTypeReference

public InnerTypeReference newParameterizedTypeReference(LightweightTypeReference outer,
                                               JvmType type)

Description copied from interface: ITypeReferenceOwner

Creates a new InnerTypeReference. Constraints apply as with ITypeReferenceOwner.newParameterizedTypeReference(JvmType). If type does not represent a non-static inner class, an exception is thrown. This method produces references of the form Outer<OuterParams>.Type.

Specified by:

newParameterizedTypeReference in interface ITypeReferenceOwner

Parameters:

outer - the outer type reference.

type - the raw type for the newly produced ParameterizedTypeReference

newUnknownTypeReference

public UnknownTypeReference newUnknownTypeReference()

Description copied from interface: ITypeReferenceOwner

Creates a new unnamed UnknownTypeReference.

Specified by:

newUnknownTypeReference in interface ITypeReferenceOwner

newUnknownTypeReference

public UnknownTypeReference newUnknownTypeReference(String name)

Description copied from interface: ITypeReferenceOwner

Creates a new named UnknownTypeReference.

Specified by:

newUnknownTypeReference in interface ITypeReferenceOwner

newAnyTypeReference

public AnyTypeReference newAnyTypeReference()

Description copied from interface: ITypeReferenceOwner

Creates a new representation of the any type, e.g. the type of the value null.

Specified by:

newAnyTypeReference in interface ITypeReferenceOwner

newReferenceToObject

public LightweightTypeReference newReferenceToObject()

Creates a references to Object or returns an UnknownTypeReference if no JRE is available.

Specified by:

newReferenceToObject in interface ITypeReferenceOwner

newWildcardExtendsObject

public WildcardTypeReference newWildcardExtendsObject()

Creates a wildcard reference to Object or returns a wildcard to an UnknownTypeReference if no JRE is available.

Specified by:

newWildcardExtendsObject in interface ITypeReferenceOwner

newReferenceTo

public LightweightTypeReference newReferenceTo(Class<?> type)

Creates a references to the given class or returns an UnknownTypeReference if no JRE is available.

Specified by:

newReferenceTo in interface ITypeReferenceOwner

newReferenceTo

public LightweightTypeReference newReferenceTo(Class<?> type,
                                      TypeReferenceInitializer<? super ParameterizedTypeReference> init)

Creates a references to the given class or returns an UnknownTypeReference if no JRE is available. If the type is available, the given acceptor is used to initialize it further.

Specified by:

newReferenceTo in interface ITypeReferenceOwner