org.eclipse.ocl.pivot

Interface StandardLibrary

All Superinterfaces:

Element, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Visitable

All Known Subinterfaces:

StandardLibrary.StandardLibraryExtension, StandardLibraryInternal

All Known Implementing Classes:

ExecutableStandardLibrary, ExecutorStandardLibrary, PivotExecutorStandardLibrary, StandardLibraryImpl

public interface StandardLibrary
extends Element

A representation of the model object 'Standard Library'.

See Also:

PivotPackage.getStandardLibrary()

Generated

Noimplement:

This interface is not intended to be implemented by clients.

The following features are supported:

• Owning Complete Environment

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StandardLibrary.StandardLibraryExtension

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<? extends CompletePackage>	getAllCompletePackages()
Class	getBagType() Obtains the generic instance of the BagType metatype, named Bag(T).
Class	getBooleanType() Obtains the instance of the PrimitiveType metatype, named Boolean.
Class	getClassType() Obtains the single instance of the org.eclipse.ocl.pivot.Class metatype, named Class.
Class	getCollectionType() Obtains the generic instance of the CollectionType metatype, named Collection(T).
CollectionType	getCollectionType(Class containerType, Type elementType, boolean isNullFree, IntegerValue lower, UnlimitedNaturalValue upper)
CollectionType	getCollectionType(Class containerType, Type elementType, IntegerValue lower, UnlimitedNaturalValue upper) Deprecated. add isNullFree argument
Class	getEnumerationType() Obtains the single instance of the EnumerationType metatype, named Enumeration.
CompleteInheritance	getInheritance(Class type) Return the Inheritance dispatch table for a given type.
Class	getIntegerType() Obtains the instance of the PrimitiveType metatype, named Integer.
Class	getMapType()
MapType	getMapType(Class containerType, Type keyType, Type valueType)
Class	getMetaclass(Type classType) Return the instance of the Metaclass metatype whose class is classType.
Type	getMetaType(Type type) Returns the meta-type of a given type.
Package	getNsURIPackage(java.lang.String nsURI)
Class	getOclAnyType() Obtains the single instance of the AnyType metatype, named OclAny.
Class	getOclComparableType() Obtains the single instance of the OclComparable metatype, named OclAny.
Class	getOclElementType() Obtains the single instance of the Class metatype, named OclElement.
Operation	getOclInvalidOperation()
Class	getOclInvalidType() Obtains the single instance of the InvalidType metatype, named OclInvalid.
Class	getOclMessageType() Obtains the generic instance of the MessageType metatype, named OclMessage.
Class	getOclSelfType() Obtains the single instance of the OclSelf pseudo-metatype, named OclSelf.
Class	getOclStereotypeType() Obtains the single instance of the OclStereotype metatype, named OclStereotype.
Class	getOclSummableType() Obtains the single instance of the OclSummable metatype, named OclAny.
Class	getOclTupleType() Obtains the single instance of the OclTupleType metatype, named OclVoid.
Type	getOclType(java.lang.String typeName)
Class	getOclVoidType() Obtains the single instance of the VoidType metatype, named OclVoid.
Element	getOperationTemplateParameter(Operation anOperation, int index)
Class	getOrderedCollectionType() Obtains the generic instance of the OrderedCollection metatype, named OrderedCollection(T).
Class	getOrderedSetType() Obtains the generic instance of the OrderedSetType metatype, named OrderedSet(T).
CompleteEnvironment	getOwningCompleteEnvironment() Returns the value of the 'Owning Complete Environment' container reference.
Package	getPackage() Obtains the package containing the library types
Type	getPrimitiveType(PrimitiveTypeId id)
Class	getRealType() Obtains the instance of the PrimitiveType metatype, named Real.
Package	getRootPackage(java.lang.String name)
Class	getSequenceType() Obtains the generic instance of the SequenceType metatype, named Sequence(T).
Class	getSetType() Obtains the generic instance of the SetType metatype, named Set(T).
Class	getStringType() Obtains the instance of the PrimitiveType metatype, named String.
Class	getUniqueCollectionType() Obtains the generic instance of the UniqueCollection metatype, named Set(T).
Class	getUnlimitedNaturalType() Obtains the instance of the PrimitiveType metatype, named UnlimitedNatural.
void	setOwningCompleteEnvironment(CompleteEnvironment value) Sets the value of the 'Owning Complete Environment' container reference.

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

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

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

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

eClass

Method Detail

getOwningCompleteEnvironment

CompleteEnvironment getOwningCompleteEnvironment()

Returns the value of the 'Owning Complete Environment' container reference. It is bidirectional and its opposite is 'Owned Standard Library'.

If the meaning of the 'Owning Complete Environment' container reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Owning Complete Environment' container reference.

See Also:

setOwningCompleteEnvironment(CompleteEnvironment), PivotPackage.getStandardLibrary_OwningCompleteEnvironment(), CompleteEnvironment.getOwnedStandardLibrary()

Generated

setOwningCompleteEnvironment

void setOwningCompleteEnvironment(CompleteEnvironment value)

Sets the value of the 'Owning Complete Environment' container reference.

Parameters:

value - the new value of the 'Owning Complete Environment' container reference.

See Also:

getOwningCompleteEnvironment()

Generated

getAllCompletePackages

@NonNull
java.lang.Iterable<? extends CompletePackage> getAllCompletePackages()

getBagType

Class getBagType()

Obtains the generic instance of the BagType metatype, named Bag(T).

Returns:

the Bag(T) type (an instance of BagType)

getBooleanType

Class getBooleanType()

Obtains the instance of the PrimitiveType metatype, named Boolean.

Returns:

the Boolean type (an instance of PrimitiveType)

getClassType

Class getClassType()

Obtains the single instance of the org.eclipse.ocl.pivot.Class metatype, named Class.

Returns:

the Class type (an instance of Class)

getCollectionType

Class getCollectionType()

Obtains the generic instance of the CollectionType metatype, named Collection(T).

Returns:

the Collection(T) type (an instance of CollectionType)

getCollectionType

@Deprecated
 @NonNull
CollectionType getCollectionType(Class containerType,
                                                         @NonNull
                                                         Type elementType,
                                                         @Nullable
                                                         IntegerValue lower,
                                                         @Nullable
                                                         UnlimitedNaturalValue upper)

Deprecated. add isNullFree argument

getCollectionType

@NonNull
CollectionType getCollectionType(Class containerType,
                                           @NonNull
                                           Type elementType,
                                           boolean isNullFree,
                                           @Nullable
                                           IntegerValue lower,
                                           @Nullable
                                           UnlimitedNaturalValue upper)

getEnumerationType

Class getEnumerationType()

Obtains the single instance of the EnumerationType metatype, named Enumeration.

Returns:

the Enumeration type (an instance of Enumeration)

getInheritance

@NonNull
CompleteInheritance getInheritance(Class type)

Return the Inheritance dispatch table for a given type.

getIntegerType

Class getIntegerType()

Obtains the instance of the PrimitiveType metatype, named Integer.

Returns:

the Integer type (an instance of PrimitiveType)

getMapType

Class getMapType()

getMapType

@NonNull
MapType getMapType(Class containerType,
                             @NonNull
                             Type keyType,
                             @NonNull
                             Type valueType)

getMetaclass

Class getMetaclass(@NonNull
                   Type classType)

Return the instance of the Metaclass metatype whose class is classType.

getMetaType

Type getMetaType(@NonNull
                 Type type)

Returns the meta-type of a given type.

getNsURIPackage

Package getNsURIPackage(@NonNull
                        java.lang.String nsURI)

getOclAnyType

Class getOclAnyType()

Obtains the single instance of the AnyType metatype, named OclAny.

Returns:

the OclAny type (an instance of AnyType)

getOclComparableType

Class getOclComparableType()

Obtains the single instance of the OclComparable metatype, named OclAny.

Returns:

the OclAny type (an instance of Class)

getOclElementType

Class getOclElementType()

Obtains the single instance of the Class metatype, named OclElement.

Returns:

the OclElement type (an instance of Class)

getOclInvalidOperation

@NonNull
Operation getOclInvalidOperation()

getOclInvalidType

Class getOclInvalidType()

Obtains the single instance of the InvalidType metatype, named OclInvalid.

Returns:

the OclInvalid type (an instance of InvalidType)

getOclMessageType

Class getOclMessageType()

Obtains the generic instance of the MessageType metatype, named OclMessage.

Returns:

the OclMessage type (an instance of MessageType)

getOclSelfType

Class getOclSelfType()

Obtains the single instance of the OclSelf pseudo-metatype, named OclSelf.

Returns:

the OclSelf type (an instance of SelfType)

getOclStereotypeType

Class getOclStereotypeType()

Obtains the single instance of the OclStereotype metatype, named OclStereotype.

Returns:

the OclStereotype type (an instance of Class)

Since:

1.1

getOclSummableType

Class getOclSummableType()

Obtains the single instance of the OclSummable metatype, named OclAny.

Returns:

the OclAny type (an instance of Class)

getOclTupleType

Class getOclTupleType()

Obtains the single instance of the OclTupleType metatype, named OclVoid.

Returns:

the OclTuple type (an instance of Class)

getOclType

Type getOclType(@NonNull
                java.lang.String typeName)

getOclVoidType

Class getOclVoidType()

Obtains the single instance of the VoidType metatype, named OclVoid.

Returns:

the OclVoid type (an instance of VoidType)

getOperationTemplateParameter

Element getOperationTemplateParameter(@NonNull
                                      Operation anOperation,
                                      int index)

getOrderedCollectionType

Class getOrderedCollectionType()

Obtains the generic instance of the OrderedCollection metatype, named OrderedCollection(T).

Returns:

the OrderedCollection(T) type (an instance of CollectionType)

getOrderedSetType

Class getOrderedSetType()

Obtains the generic instance of the OrderedSetType metatype, named OrderedSet(T).

Returns:

the OrderedSet(T) type (an instance of OrderedSetType)

getPackage

Package getPackage()

Obtains the package containing the library types

getPrimitiveType

Type getPrimitiveType(@NonNull
                      PrimitiveTypeId id)

getRealType

Class getRealType()

Obtains the instance of the PrimitiveType metatype, named Real.

Returns:

the Real type (an instance of PrimitiveType)

getRootPackage

Package getRootPackage(@NonNull
                       java.lang.String name)

getSequenceType

Class getSequenceType()

Obtains the generic instance of the SequenceType metatype, named Sequence(T).

Returns:

the Sequence(T) type (an instance of SequenceType)

getSetType

Class getSetType()

Obtains the generic instance of the SetType metatype, named Set(T).

Returns:

the Set(T) type (an instance of SetType)

getStringType

Class getStringType()

Obtains the instance of the PrimitiveType metatype, named String.

Returns:

the String type (an instance of PrimitiveType)

getUniqueCollectionType

Class getUniqueCollectionType()

Obtains the generic instance of the UniqueCollection metatype, named Set(T).

Returns:

the Set(T) type (an instance of CollectionType)

getUnlimitedNaturalType

Class getUnlimitedNaturalType()

Obtains the instance of the PrimitiveType metatype, named UnlimitedNatural.

Returns:

the UnlimitedNatural type (an instance of PrimitiveType)