org.eclipse.ocl.examples.codegen.java.types

Class AbstractDescriptor

java.lang.Object

org.eclipse.ocl.examples.codegen.java.types.AbstractDescriptor

All Implemented Interfaces:

TypeDescriptor

Direct Known Subclasses:

AbstractCollectionDescriptor, AbstractValueDescriptor, FutureEObjectDescriptor, RootObjectDescriptor, SimpleDataTypeDescriptor, UnboxedMapDescriptor

public abstract class AbstractDescriptor
extends Object
implements TypeDescriptor

An AbstractDescriptor provides the most fundamental capabilities of any type description: the correspondence to a pivot ElementId.

Constructor Summary

Constructors

Constructor and Description
AbstractDescriptor(ElementId elementId)

Method Summary

Modifier and Type	Method and Description
Boolean	appendBox(JavaStream js, JavaLocalContext<?> localContext, CGBoxExp cgBoxExp, CGValuedElement unboxedValue) Append the appropriate statements to js to create the boxed value for cgBboxExp from its unboxedValue.
void	appendCast(JavaStream js, Class<?> actualJavaClass, JavaStream.SubStream subStream) Append the actualJavaClass subStream to js wrapped in a cast to this type.g.
void	appendCastTerm(JavaStream js, CGValuedElement cgElement) Append a cgElement to js wrapped in a cast to this type
Boolean	appendEcore(JavaStream js, JavaLocalContext<?> localContext, CGEcoreExp cgEcoreExp, CGValuedElement unboxedValue) Append a conversion to an Ecore value.
Boolean	appendEcoreStatements(JavaStream js, JavaLocalContext<?> localContext, CGEcoreExp cgEcoreExp, CGValuedElement boxedValue) Append the appropriate statements to js to create the ecore value for cgEcoreExp from its boxedValue.
void	appendEcoreValue(JavaStream js, String requiredClassName, CGValuedElement cgValue) Append cgValue to js casting an internally typed Ecore value to requiredClassName.
void	appendEqualsValue(JavaStream js, CGValuedElement thisValue, CGValuedElement thatValue, boolean notEquals) Append an expression term that evaluates whether (this TypedDescriptor and) thisValue is not equals/ notEquals to thatValue.
void	appendNotEqualsTerm(JavaStream js, CGValuedElement thisValue, TypeDescriptor thatTypeDescriptor, String thatName) Append an expression term that evaluates whether (this TypedDescriptor and) thisValue is not equal to thatTypeDescriptor and thatName.
Boolean	appendUnboxStatements(JavaStream js, JavaLocalContext<?> localContext, CGUnboxExp cgUnboxExp, CGValuedElement boxedValue) Append the appropriate statements to js to create the unboxed value for cgUnboxExp from its boxedValue.
CollectionDescriptor	asCollectionDescriptor() Return a non-null Collection type descriptor if this type descriptor describes a Collection.
EClassifier	getEClassifier() Return the Ecore EClassifier described by this type.
ElementId	getElementId()
TypeDescriptor	getPrimitiveDescriptor() Return the type descriptor for use when a primitive type would be appropriate.
boolean	isAssignableTo(Class<?> javaClass) Return true if an instance described by this typeDescriptor may be assigned to a javaClass.
boolean	isPrimitive() Return true is this is a built-in primitive type such as boolean or int.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.ocl.examples.codegen.generator.TypeDescriptor

append, getClassName, getEcoreDescriptor, getJavaClass, getUnboxedDescriptor, hasJavaClass, isAssignableFrom

Constructor Detail

AbstractDescriptor

public AbstractDescriptor(ElementId elementId)

Method Detail

appendBox

public Boolean appendBox(JavaStream js,
                         JavaLocalContext<?> localContext,
                         CGBoxExp cgBoxExp,
                         CGValuedElement unboxedValue)

Description copied from interface: TypeDescriptor

Append the appropriate statements to js to create the boxed value for cgBboxExp from its unboxedValue.

Specified by:

appendBox in interface TypeDescriptor

appendCast

public void appendCast(JavaStream js,
                       Class<?> actualJavaClass,
                       JavaStream.SubStream subStream)

Description copied from interface: TypeDescriptor

Append the actualJavaClass subStream to js wrapped in a cast to this type.g. "(typename)subStream"

Specified by:

appendCast in interface TypeDescriptor

appendCastTerm

public void appendCastTerm(JavaStream js,
                           CGValuedElement cgElement)

Description copied from interface: TypeDescriptor

Append a cgElement to js wrapped in a cast to this type

Specified by:

appendCastTerm in interface TypeDescriptor

appendEcore

public Boolean appendEcore(JavaStream js,
                           JavaLocalContext<?> localContext,
                           CGEcoreExp cgEcoreExp,
                           CGValuedElement unboxedValue)

Description copied from interface: TypeDescriptor

Append a conversion to an Ecore value.

Specified by:

appendEcore in interface TypeDescriptor

appendEcoreValue

public void appendEcoreValue(JavaStream js,
                             String requiredClassName,
                             CGValuedElement cgValue)

Description copied from interface: TypeDescriptor

Append cgValue to js casting an internally typed Ecore value to requiredClassName. This is primarily used to cast a List<...> to an EList<...>. The default just appends the value name of cgValue.

Specified by:

appendEcoreValue in interface TypeDescriptor

appendNotEqualsTerm

public void appendNotEqualsTerm(JavaStream js,
                                CGValuedElement thisValue,
                                TypeDescriptor thatTypeDescriptor,
                                String thatName)

Description copied from interface: TypeDescriptor

Append an expression term that evaluates whether (this TypedDescriptor and) thisValue is not equal to thatTypeDescriptor and thatName.

Specified by:

appendNotEqualsTerm in interface TypeDescriptor

appendEcoreStatements

public Boolean appendEcoreStatements(JavaStream js,
                                     JavaLocalContext<?> localContext,
                                     CGEcoreExp cgEcoreExp,
                                     CGValuedElement boxedValue)

Description copied from interface: TypeDescriptor

Append the appropriate statements to js to create the ecore value for cgEcoreExp from its boxedValue.

Specified by:

appendEcoreStatements in interface TypeDescriptor

appendEqualsValue

public void appendEqualsValue(JavaStream js,
                              CGValuedElement thisValue,
                              CGValuedElement thatValue,
                              boolean notEquals)

Description copied from interface: TypeDescriptor

Append an expression term that evaluates whether (this TypedDescriptor and) thisValue is not equals/ notEquals to thatValue.
It is assumed that all the degenerate constant cases have been optimzed away.

Specified by:

appendEqualsValue in interface TypeDescriptor

appendUnboxStatements

public Boolean appendUnboxStatements(JavaStream js,
                                     JavaLocalContext<?> localContext,
                                     CGUnboxExp cgUnboxExp,
                                     CGValuedElement boxedValue)

Description copied from interface: TypeDescriptor

Append the appropriate statements to js to create the unboxed value for cgUnboxExp from its boxedValue.

Specified by:

appendUnboxStatements in interface TypeDescriptor

asCollectionDescriptor

public CollectionDescriptor asCollectionDescriptor()

Description copied from interface: TypeDescriptor

Return a non-null Collection type descriptor if this type descriptor describes a Collection.

Specified by:

asCollectionDescriptor in interface TypeDescriptor

getEClassifier

public EClassifier getEClassifier()

Description copied from interface: TypeDescriptor

Return the Ecore EClassifier described by this type. In the case of collection types, this method returns the EClassifier of the collection elements. May return null when no EClssifier available.

Specified by:

getEClassifier in interface TypeDescriptor

getElementId

public ElementId getElementId()

getPrimitiveDescriptor

public TypeDescriptor getPrimitiveDescriptor()

Description copied from interface: TypeDescriptor

Return the type descriptor for use when a primitive type would be appropriate. Returns this when there is no distinction for primitive types.

Specified by:

getPrimitiveDescriptor in interface TypeDescriptor

isAssignableTo

public boolean isAssignableTo(Class<?> javaClass)

Description copied from interface: TypeDescriptor

Return true if an instance described by this typeDescriptor may be assigned to a javaClass.

Specified by:

isAssignableTo in interface TypeDescriptor

isPrimitive

public boolean isPrimitive()

Description copied from interface: TypeDescriptor

Return true is this is a built-in primitive type such as boolean or int. Such types cannot have @NonNull annotations.

Specified by:

isPrimitive in interface TypeDescriptor

toString

public String toString()

Overrides:

toString in class Object