org.eclipse.ocl.pivot

Interface Class

All Superinterfaces:

Element, Nameable, NamedElement, Namespace, OCLValue, TemplateableElement, Type, Visitable

All Known Subinterfaces:

AnyType, AssociationClass, BagType, Behavior, CollectionType, DataType, DynamicBehavior, DynamicType, ElementExtension, Enumeration, InvalidType, LambdaType, MapType, MessageType, OrderedSetType, PrimitiveType, SelfType, SequenceType, SetType, Signal, StateMachine, Stereotype, TupleType, VoidType, WildcardType

All Known Implementing Classes:

AbstractExecutorClass, AbstractReflectiveInheritanceType, AbstractSpecializedType, AnyTypeImpl, AssociationClassImpl, BagTypeImpl, BehaviorImpl, ClassImpl, CollectionTypeImpl, CompleteInheritanceImpl, DataTypeImpl, DomainReflectiveType, DynamicBehaviorImpl, DynamicTypeImpl, EcoreExecutorEnumeration, EcoreExecutorInvalidType, EcoreExecutorType, EcoreExecutorVoidType, EcoreReflectiveEnumeration, EcoreReflectiveType, ElementExtensionImpl, EnumerationImpl, ExecutorCollectionType, ExecutorLambdaType, ExecutorMapType, ExecutorSpecializedType, ExecutorTupleType, ExecutorTupleType, ExecutorType, InvalidTypeImpl, JavaType, LambdaTypeImpl, MapTypeImpl, MessageTypeImpl, OrderedSetTypeImpl, PrimitiveTypeImpl, ReflectiveInheritance, SelfTypeImpl, SequenceTypeImpl, SetTypeImpl, SignalImpl, StateMachineImpl, StereotypeImpl, TupleTypeImpl, VoidTypeImpl, WildcardTypeImpl

public interface Class
extends Type, Namespace, TemplateableElement

A representation of the model object 'Class'.

See Also:

PivotPackage.getClass_()

EMF generated code

Interface is not intended to be implemented by clients.

A Class classifies a set of objects and specifies the features that characterize the structure and behavior of those objects. A Class may have an internal structure and Ports. A Classifier represents a classification of instances according to their Features. StructuredClassifiers may contain an internal structure of connected elements each of which plays a role in the overall Behavior modeled by the StructuredClassifier.

The following features are supported:

• Extenders
• Instance Class Name
• Is Abstract
• Is Active
• Is Interface
• Owned Behaviors
• Owned Invariants
• Owned Operations
• Owned Properties
• Owning Package
• Super Classes

Method Summary

Modifier and Type	Method and Description
EObject	createInstance() Return a new instance of this type from valueFactory.
Object	createInstance(String value) Return a new instance of this data type from valueFactory.
List<StereotypeExtender>	getExtenders() Returns the value of the 'Extenders' reference list.
String	getInstanceClassName() Returns the value of the 'Instance Class Name' attribute.
String	getMetaTypeName() Return the name of the meta-type of this type.
List<Behavior>	getOwnedBehaviors() Returns the value of the 'Owned Behaviors' 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.
List<Class>	getSuperClasses() Returns the value of the 'Super Classes' reference list.
TemplateParameters	getTypeParameters() Return the ordered list of type parameters of this type.
boolean	isIsAbstract() Returns the value of the 'Is Abstract' attribute.
boolean	isIsActive() Returns the value of the 'Is Active' attribute.
boolean	isIsInterface() Returns the value of the 'Is Interface' attribute.
boolean	isOrdered() Return true if this type is a Collection type and has ordered elements.
boolean	isUnique() Return true if this type is a Collection type and has unique elements.
Operation	lookupActualOperation(StandardLibrary standardLibrary, Operation apparentOperation)
LibraryFeature	lookupImplementation(StandardLibrary standardLibrary, Operation apparentOperation) Return the dynamic (overloaded) implementation of the staticOperation applicable to the types managed by the given Standard Library.
void	setInstanceClassName(String value) Sets the value of the 'Instance Class Name' attribute.
void	setIsAbstract(boolean value) Sets the value of the 'Is Abstract' attribute.
void	setIsActive(boolean value) Sets the value of the 'Is Active' attribute.
void	setIsInterface(boolean value) Sets the value of the 'Is Interface' attribute.
void	setOwningPackage(Package value) Sets the value of the 'Owning Package' container reference.
boolean	validateNameIsNotNull(DiagnosticChain diagnostics, Map<Object,Object> context)
boolean	validateUniqueInvariantName(DiagnosticChain diagnostics, Map<Object,Object> context)

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

conformsTo, flattenedType, getCommonType, getInheritance, getNormalizedType, getTypeId, isClass, isEqualTo, isEqualToUnspecializedType, isTemplateParameter, specializeIn

Methods inherited from interface org.eclipse.ocl.pivot.values.OCLValue

oclEquals, oclHashCode

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

getOwnedConstraints

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

getOwnedBindings, getOwnedSignature, getUnspecializedElement, setOwnedSignature, setUnspecializedElement

Method Detail

getExtenders

List<StereotypeExtender> getExtenders()

Returns the value of the 'Extenders' reference list. The list contents are of type StereotypeExtender. It is bidirectional and its opposite is 'Class'.

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

Returns:

the value of the 'Extenders' reference list.

See Also:

PivotPackage.getClass_Extenders(), StereotypeExtender.getClass_()

EMF generated code

getInstanceClassName

String getInstanceClassName()

Returns the value of the 'Instance Class Name' attribute.

If the meaning of the 'Instance Class Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Instance Class Name' attribute.

See Also:

setInstanceClassName(String), PivotPackage.getClass_InstanceClassName()

EMF generated code

setInstanceClassName

void setInstanceClassName(String value)

Sets the value of the 'Instance Class Name' attribute.

Parameters:

value - the new value of the 'Instance Class Name' attribute.

See Also:

getInstanceClassName()

EMF generated code

isIsAbstract

boolean isIsAbstract()

Returns the value of the 'Is Abstract' attribute. The default value is "false". If true, the Class does not provide a complete declaration and cannot be instantiated. An abstract Class is typically used as a target of Associations or Generalizations. If true, the Classifier can only be instantiated by instantiating one of its specializations. An abstract Classifier is intended to be used by other Classifiers e.g., as the target of Associations or Generalizations.

Returns:

the value of the 'Is Abstract' attribute.

See Also:

setIsAbstract(boolean), PivotPackage.getClass_IsAbstract()

EMF generated code

setIsAbstract

void setIsAbstract(boolean value)

Sets the value of the 'Is Abstract' attribute.

Parameters:

value - the new value of the 'Is Abstract' attribute.

See Also:

isIsAbstract()

EMF generated code

isIsActive

boolean isIsActive()

Returns the value of the 'Is Active' attribute. The default value is "false". Determines whether an object specified by this Class is active or not. If true, then the owning Class is referred to as an active Class. If false, then such a Class is referred to as a passive Class.

Returns:

the value of the 'Is Active' attribute.

See Also:

setIsActive(boolean), PivotPackage.getClass_IsActive()

EMF generated code

setIsActive

void setIsActive(boolean value)

Sets the value of the 'Is Active' attribute.

Parameters:

value - the new value of the 'Is Active' attribute.

See Also:

isIsActive()

EMF generated code

isIsInterface

boolean isIsInterface()

Returns the value of the 'Is Interface' attribute. The default value is "false".

If the meaning of the 'Is Interface' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Is Interface' attribute.

See Also:

setIsInterface(boolean), PivotPackage.getClass_IsInterface()

EMF generated code

getOwnedInvariants

List<Constraint> getOwnedInvariants()

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

Returns:

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

See Also:

PivotPackage.getClass_OwnedInvariants()

EMF generated code

getOwnedOperations

List<Operation> getOwnedOperations()

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.

Returns:

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

See Also:

PivotPackage.getClass_OwnedOperations(), Operation.getOwningClass()

EMF generated code

getOwningPackage

Package getOwningPackage()

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

Returns:

the value of the 'Owning Package' container reference.

See Also:

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

EMF generated code

setOwningPackage

void setOwningPackage(Package value)

Sets the value of the 'Owning Package' container reference.

Parameters:

value - the new value of the 'Owning Package' container reference.

See Also:

getOwningPackage()

EMF generated code

getSuperClasses

List<Class> getSuperClasses()

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

Returns:

the value of the 'Super Classes' reference list.

See Also:

PivotPackage.getClass_SuperClasses()

EMF generated code

validateNameIsNotNull

boolean validateNameIsNotNull(DiagnosticChain diagnostics,
                              Map<Object,Object> context)

Since:

1.3

EMF generated code

validateUniqueInvariantName

boolean validateUniqueInvariantName(DiagnosticChain diagnostics,
                                    Map<Object,Object> context)

EMF generated code

setIsInterface

void setIsInterface(boolean value)

Sets the value of the 'Is Interface' attribute.

Parameters:

value - the new value of the 'Is Interface' attribute.

See Also:

isIsInterface()

EMF generated code

getOwnedBehaviors

List<Behavior> getOwnedBehaviors()

Returns the value of the 'Owned Behaviors' containment reference list. The list contents are of type Behavior.

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

Behaviors owned by a BehavioredClassifier.

Returns:

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

See Also:

PivotPackage.getClass_OwnedBehaviors()

EMF generated code

getOwnedProperties

List<Property> getOwnedProperties()

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.

Returns:

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

See Also:

PivotPackage.getClass_OwnedProperties(), Property.getOwningClass()

EMF generated code

createInstance

EObject createInstance()

Return a new instance of this type from valueFactory. Properties may be initialised using Property.initValue(Object, Object) provided no side-effect free OCL functionality is permitted to use the ObjectValue until initialisation has completed.

createInstance

Object createInstance(String value)

Return a new instance of this data type from valueFactory.

Parameters:

value - string initial value

getMetaTypeName

String getMetaTypeName()

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

getTypeParameters

TemplateParameters getTypeParameters()

Return the ordered list of type parameters of this type.

isOrdered

boolean isOrdered()

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

isUnique

boolean isUnique()

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

lookupImplementation

LibraryFeature lookupImplementation(StandardLibrary standardLibrary,
                                    Operation apparentOperation)

Return the dynamic (overloaded) implementation of the staticOperation applicable to the types managed by the given Standard Library.

lookupActualOperation

Operation lookupActualOperation(StandardLibrary standardLibrary,
                                Operation apparentOperation)