org.eclipse.ocl.pivot.internal.library.executor

Class ExecutorType

java.lang.Object

org.eclipse.ocl.pivot.internal.elements.AbstractExecutorElement

org.eclipse.ocl.pivot.internal.elements.AbstractExecutorNamedElement

org.eclipse.ocl.pivot.types.AbstractInheritance

org.eclipse.ocl.pivot.internal.elements.AbstractExecutorType

org.eclipse.ocl.pivot.internal.elements.AbstractExecutorClass

org.eclipse.ocl.pivot.internal.library.executor.ExecutorType

All Implemented Interfaces:

Class, CompleteInheritance, Element, ExecutorTypeArgument, NamedElement, Namespace, TemplateableElement, Type, Visitable, Nameable, OCLValue

Direct Known Subclasses:

EcoreExecutorType

public abstract class ExecutorType
extends AbstractExecutorClass
implements ExecutorTypeArgument

An ExecutorType defines a Type using a compact representation suitable for efficient execution and static construction.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.ocl.pivot.types.AbstractInheritance

AbstractInheritance.FragmentIterable

Field Summary

Fields inherited from class org.eclipse.ocl.pivot.types.AbstractInheritance

ABSTRACT, OCL_ANY, OCL_INVALID, OCL_VOID, ORDERED, UNIQUE

Fields inherited from interface org.eclipse.ocl.pivot.CompleteInheritance

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
ExecutorType(String name, ExecutorPackage evaluationPackage, int flags, ExecutorTypeParameter... typeParameters)

Method Summary

Modifier and Type	Method and Description
boolean	conformsTo(StandardLibrary standardLibrary, Type type) Return true if this type conform to thatType within standardLibrary.
Class	flattenedType()
AbstractInheritance.FragmentIterable	getAllProperSuperFragments() Return a depth ordered, OclAny-first, OclSelf-last, Iterable of all the super-adapters excluding this one.
AbstractInheritance.FragmentIterable	getAllSuperFragments() Return a depth ordered, OclAny-first, OclSelf-last, Iterable of all the super-adapters including this one.
Type	getCommonType(IdResolver idResolver, Type type) Return the most derived type common to this type and thatType within standardLibrary.
int	getDepth() Return the inheritance depth of the target type: OclAny is at depth 0.
ExecutorFragment	getFragment(int fragmentNumber)
Iterable<InheritanceFragment>	getFragments()
int	getIndex(int fragmentNumber)
int	getIndexes()
CompleteInheritance	getInheritance(StandardLibrary standardLibrary) Return the inheritance description for this type within standardLibrary.
Operation	getMemberOperation(OperationId operationId)
Property	getMemberProperty(String name)
String	getMetaTypeName() Return the name of the meta-type of this type.
Class	getNormalizedType(StandardLibrary standardLibrary) Return the unique executable form of this type within standardLibrary.
List<Constraint>	getOwnedConstraints() Returns the value of the 'Owned Constraints' containment reference list.
List<Constraint>	getOwnedInvariants() Returns the value of the 'Owned Invariants' containment reference list.
List<Operation>	getOwnedOperations() Returns the value of the 'Owned Operations' containment reference list.
List<Property>	getOwnedProperties() Returns the value of the 'Owned Properties' containment reference list.
Package	getOwningPackage() Returns the value of the 'Owning Package' container reference.
Class	getPivotClass()
ExecutorFragment	getSelfFragment()
StandardLibrary	getStandardLibrary()
List<Class>	getSuperClasses() Returns the value of the 'Super Classes' reference list.
AbstractInheritance.FragmentIterable	getSuperFragments(int depth) Return an Iterable of all the super-inheritances at a specified depth, between 0 and getDepth() inclusive.
TemplateParameters	getTypeParameters() Return the ordered list of type parameters of this type.
void	initFragments(ExecutorFragment[] fragments, int[] depthCounts)
Class	isClass()
boolean	isEqualTo(StandardLibrary standardLibrary, Type type) Return true if this is the same type as thatType within standardLibrary.
boolean	isEqualToUnspecializedType(StandardLibrary standardLibrary, Type type)
boolean	isOrdered() Return true if this type is a Collection type and has ordered elements.
TemplateParameter	isTemplateParameter()
boolean	isUnique() Return true if this type is a Collection type and has unique elements.
boolean	oclEquals(OCLValue thatValue) Return true if this is an equivalent OCL value to thatValue.
int	oclHashCode()
String	toString()

Methods inherited from class org.eclipse.ocl.pivot.internal.elements.AbstractExecutorClass

createInstance, createInstance, getBehavioralClass, getExtenders, getInstanceClassName, getOwnedBehaviors, getOwnedBindings, getOwnedSignature, getUnspecializedElement, isIsAbstract, isIsActive, isIsInterface, isIsSerializable, setBehavioralClass, setInstanceClassName, setIsAbstract, setIsActive, setIsInterface, setIsSerializable, setOwnedSignature, setOwningPackage, setUnspecializedElement, validateNameIsNotNull, validateUniqueInvariantName

Methods inherited from class org.eclipse.ocl.pivot.internal.elements.AbstractExecutorType

getTypeId, specializeIn

Methods inherited from class org.eclipse.ocl.pivot.types.AbstractInheritance

getCommonInheritance, getFragment, getType, initStatics, isInvalid, isOclAny, isSubInheritanceOf, isSuperInheritanceOf, isUndefined, lookupActualOperation, lookupImplementation, lookupLocalOperation

Methods inherited from class org.eclipse.ocl.pivot.internal.elements.AbstractExecutorNamedElement

getName, setName

Methods inherited from class org.eclipse.ocl.pivot.internal.elements.AbstractExecutorElement

accept, allOwnedElements, eAdapters, eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eDeliver, eGet, eGet, eInvoke, eIsProxy, eIsSet, eNotify, eResource, eSet, eSetDeliver, eUnset, getAnnotatingComments, getESObject, getETarget, getOwnedAnnotations, getOwnedComments, getOwnedExtensions, getValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ocl.pivot.Type

getTypeId, specializeIn

Methods inherited from interface org.eclipse.ocl.pivot.NamedElement

getName, setName

Methods inherited from interface org.eclipse.ocl.pivot.Element

accept, allOwnedElements, getAnnotatingComments, getESObject, getETarget, getOwnedAnnotations, getOwnedComments, getOwnedExtensions, getValue

Methods inherited from interface org.eclipse.ocl.pivot.util.Visitable

eClass

Methods inherited from interface org.eclipse.ocl.pivot.Class

lookupActualOperation, lookupImplementation

Constructor Detail

ExecutorType

public ExecutorType(String name,
                    ExecutorPackage evaluationPackage,
                    int flags,
                    ExecutorTypeParameter... typeParameters)

Method Detail

conformsTo

public boolean conformsTo(StandardLibrary standardLibrary,
                          Type type)

Description copied from interface: Type

Return true if this type conform to thatType within standardLibrary.

Specified by:

conformsTo in interface Type

Overrides:

conformsTo in class AbstractExecutorType

flattenedType

public Class flattenedType()

Description copied from interface: Type

Specified by:

flattenedType in interface Type

Overrides:

flattenedType in class AbstractExecutorType

getAllProperSuperFragments

public final AbstractInheritance.FragmentIterable getAllProperSuperFragments()

Description copied from interface: CompleteInheritance

Return a depth ordered, OclAny-first, OclSelf-last, Iterable of all the super-adapters excluding this one.

Specified by:

getAllProperSuperFragments in interface CompleteInheritance

Overrides:

getAllProperSuperFragments in class AbstractExecutorType

getAllSuperFragments

public AbstractInheritance.FragmentIterable getAllSuperFragments()

Description copied from interface: CompleteInheritance

Return a depth ordered, OclAny-first, OclSelf-last, Iterable of all the super-adapters including this one.

Specified by:

getAllSuperFragments in interface CompleteInheritance

Overrides:

getAllSuperFragments in class AbstractExecutorType

getCommonType

public Type getCommonType(IdResolver idResolver,
                          Type type)

Description copied from interface: Type

Return the most derived type common to this type and thatType within standardLibrary.

Specified by:

getCommonType in interface Type

Overrides:

getCommonType in class AbstractExecutorType

getDepth

public int getDepth()

Description copied from interface: CompleteInheritance

Return the inheritance depth of the target type: OclAny is at depth 0.

Specified by:

getDepth in interface CompleteInheritance

Overrides:

getDepth in class AbstractExecutorType

getFragments

public Iterable<InheritanceFragment> getFragments()

Specified by:

getFragments in interface CompleteInheritance

Overrides:

getFragments in class AbstractExecutorType

getFragment

public ExecutorFragment getFragment(int fragmentNumber)

Specified by:

getFragment in interface CompleteInheritance

Overrides:

getFragment in class AbstractExecutorType

getIndex

public int getIndex(int fragmentNumber)

Specified by:

getIndex in interface CompleteInheritance

Overrides:

getIndex in class AbstractExecutorType

getIndexes

public int getIndexes()

Specified by:

getIndexes in interface CompleteInheritance

Overrides:

getIndexes in class AbstractExecutorType

getInheritance

public CompleteInheritance getInheritance(StandardLibrary standardLibrary)

Description copied from interface: Type

Return the inheritance description for this type within standardLibrary.

Specified by:

getInheritance in interface Type

Overrides:

getInheritance in class AbstractExecutorClass

getMemberOperation

public Operation getMemberOperation(OperationId operationId)

Specified by:

getMemberOperation in interface CompleteInheritance

Overrides:

getMemberOperation in class AbstractExecutorType

getMemberProperty

public Property getMemberProperty(String name)

Specified by:

getMemberProperty in interface CompleteInheritance

Overrides:

getMemberProperty in class AbstractExecutorType

getMetaTypeName

public String getMetaTypeName()

Description copied from interface: Class

Return the name of the meta-type of this type.

Specified by:

getMetaTypeName in interface Class

Overrides:

getMetaTypeName in class AbstractExecutorClass

getNormalizedType

public Class getNormalizedType(StandardLibrary standardLibrary)

Description copied from interface: Type

Return the unique executable form of this type within standardLibrary.

Specified by:

getNormalizedType in interface Type

Overrides:

getNormalizedType in class AbstractExecutorType

getOwnedInvariants

public List<Constraint> getOwnedInvariants()

Description copied from interface: Class

Returns the value of the 'Owned Invariants' containment reference list. The list contents are of type Constraint.

If the meaning of the 'Owned Invariants' containment reference list isn't clear, there really should be more of a description here...

Specified by:

getOwnedInvariants in interface Class

Overrides:

getOwnedInvariants in class AbstractExecutorClass

Returns:

the value of the 'Owned Invariants' containment reference list.

See Also:

PivotPackage.getClass_OwnedInvariants()

getOwnedProperties

public List<Property> getOwnedProperties()

Description copied from interface: Class

Returns the value of the 'Owned Properties' containment reference list. The list contents are of type Property. It is bidirectional and its opposite is 'Owning Class'. The Properties owned by the StructuredClassifier. The attributes (i.e., the Properties) owned by the Class.

Specified by:

getOwnedProperties in interface Class

Overrides:

getOwnedProperties in class AbstractExecutorClass

Returns:

the value of the 'Owned Properties' containment reference list.

See Also:

PivotPackage.getClass_OwnedProperties(), Property.getOwningClass()

getOwnedOperations

public List<Operation> getOwnedOperations()

Description copied from interface: Class

Returns the value of the 'Owned Operations' containment reference list. The list contents are of type Operation. It is bidirectional and its opposite is 'Owning Class'. The Operations owned by the Class.

Specified by:

getOwnedOperations in interface Class

Overrides:

getOwnedOperations in class AbstractExecutorClass

Returns:

the value of the 'Owned Operations' containment reference list.

See Also:

PivotPackage.getClass_OwnedOperations(), Operation.getOwningClass()

getOwningPackage

public Package getOwningPackage()

Description copied from interface: Class

Returns the value of the 'Owning Package' container reference. It is bidirectional and its opposite is 'Owned Classes'.

Specified by:

getOwningPackage in interface Class

Overrides:

getOwningPackage in class AbstractExecutorClass

Returns:

the value of the 'Owning Package' container reference.

See Also:

Class.setOwningPackage(org.eclipse.ocl.pivot.Package), PivotPackage.getClass_OwningPackage(), Package.getOwnedClasses()

getOwnedConstraints

public List<Constraint> getOwnedConstraints()

Description copied from interface: Namespace

Returns the value of the 'Owned Constraints' containment reference list. The list contents are of type Constraint.

If the meaning of the 'Owned Rule' containment reference list isn't clear, there really should be more of a description here...

Specifies a set of Constraints owned by this Namespace.

Specified by:

getOwnedConstraints in interface Namespace

Overrides:

getOwnedConstraints in class AbstractExecutorClass

Returns:

the value of the 'Owned Constraints' containment reference list.

See Also:

PivotPackage.getNamespace_OwnedConstraints()

getPivotClass

public Class getPivotClass()

Specified by:

getPivotClass in interface CompleteInheritance

Overrides:

getPivotClass in class AbstractExecutorType

getSelfFragment

public ExecutorFragment getSelfFragment()

Specified by:

getSelfFragment in interface CompleteInheritance

Overrides:

getSelfFragment in class AbstractExecutorType

getStandardLibrary

public StandardLibrary getStandardLibrary()

getSuperClasses

public List<Class> getSuperClasses()

Description copied from interface: Class

Returns the value of the 'Super Classes' reference list. The list contents are of type Class.

Specified by:

getSuperClasses in interface Class

Overrides:

getSuperClasses in class AbstractExecutorClass

Returns:

the value of the 'Super Classes' reference list.

See Also:

PivotPackage.getClass_SuperClasses()

getSuperFragments

public final AbstractInheritance.FragmentIterable getSuperFragments(int depth)

Description copied from interface: CompleteInheritance

Return an Iterable of all the super-inheritances at a specified depth, between 0 and getDepth() inclusive.

Specified by:

getSuperFragments in interface CompleteInheritance

Overrides:

getSuperFragments in class AbstractExecutorType

getTypeParameters

public TemplateParameters getTypeParameters()

Description copied from interface: Class

Return the ordered list of type parameters of this type.

Specified by:

getTypeParameters in interface Class

Overrides:

getTypeParameters in class AbstractExecutorClass

initFragments

public void initFragments(ExecutorFragment[] fragments,
                          int[] depthCounts)

isClass

public Class isClass()

Specified by:

isClass in interface Type

Overrides:

isClass in class AbstractExecutorType

isEqualTo

public boolean isEqualTo(StandardLibrary standardLibrary,
                         Type type)

Description copied from interface: Type

Return true if this is the same type as thatType within standardLibrary.

Specified by:

isEqualTo in interface Type

Overrides:

isEqualTo in class AbstractExecutorType

isEqualToUnspecializedType

public boolean isEqualToUnspecializedType(StandardLibrary standardLibrary,
                                          Type type)

Specified by:

isEqualToUnspecializedType in interface Type

Overrides:

isEqualToUnspecializedType in class AbstractExecutorType

isOrdered

public boolean isOrdered()

Description copied from interface: Class

Return true if this type is a Collection type and has ordered elements.

Specified by:

isOrdered in interface Class

Overrides:

isOrdered in class AbstractExecutorClass

isTemplateParameter

public TemplateParameter isTemplateParameter()

Specified by:

isTemplateParameter in interface Type

Overrides:

isTemplateParameter in class AbstractExecutorType

isUnique

public boolean isUnique()

Description copied from interface: Class

Return true if this type is a Collection type and has unique elements.

Specified by:

isUnique in interface Class

Overrides:

isUnique in class AbstractExecutorClass

oclEquals

public boolean oclEquals(OCLValue thatValue)

Description copied from interface: OCLValue

Return true if this is an equivalent OCL value to thatValue.

Note that the caller must check that the argument is an OCLValue and should also check for the shortcut case that this == thatValue. Implementations are therefore wasting time if they re-implement the shortcut.

Specified by:

oclEquals in interface OCLValue

Overrides:

oclEquals in class AbstractExecutorType

oclHashCode

public int oclHashCode()

Specified by:

oclHashCode in interface OCLValue

Overrides:

oclHashCode in class AbstractExecutorType

toString

public String toString()

Overrides:

toString in class Object