org.eclipse.ocl.uml
Class UMLOCLStandardLibrary

java.lang.Object
  extended by org.eclipse.ocl.uml.UMLOCLStandardLibrary
All Implemented Interfaces:
OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>

public class UMLOCLStandardLibrary
extends java.lang.Object
implements OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>

An extensible implementation of the OCLStandardLibrary which provides the OCL Standard Library predefined M1 types and the associated operations related to them.

The UML-based OCL standard library represents a Package which owns all the predefined OCL types defined by the specification. The library itself is built by the the internal internal OCLStandardLibraryImpl singleton.

Since:
2.0
Author:
Adolfo Sanchez-Barbudo Herrera (adolfosbh)
See Also:
OCLStandardLibraryImpl

Constructor Summary
UMLOCLStandardLibrary()
           
 
Method Summary
 org.eclipse.uml2.uml.Classifier getBag()
          Obtains the generic instance of the BagType metatype, named Bag(T).
 org.eclipse.uml2.uml.Classifier getBoolean()
          Obtains the instance of the PrimitiveType metatype, named Boolean.
 org.eclipse.uml2.uml.Classifier getCollection()
          Obtains the generic instance of the CollectionType metatype, named Collection(T).
 org.eclipse.uml2.uml.Classifier getInteger()
          Obtains the instance of the PrimitiveType metatype, named Integer.
 java.lang.Object getInvalid()
          Obtains the single instance of the OclInvalid type, identified by the token invalid.
 org.eclipse.uml2.uml.Classifier getOclAny()
          Obtains the single instance of the AnyType metatype, named OclAny.
 org.eclipse.uml2.uml.Classifier getOclElement()
          Obtains the generic instance of the ElementType metatype, named OclElement.
 org.eclipse.uml2.uml.Classifier getOclExpression()
          Obtains the instance of the ElementType metatype that represents the type of OCL expressions in the model, named OclExpression.
 org.eclipse.uml2.uml.Classifier getOclInvalid()
          Obtains the single instance of the InvalidType metatype, named OclInvalid.
 org.eclipse.uml2.uml.Classifier getOclMessage()
          Obtains the generic instance of the MessageType metatype, named OclMessage.
 org.eclipse.uml2.uml.Package getOCLStdLibPackage()
           
 org.eclipse.uml2.uml.Classifier getOclType()
          Obtains the generic instance of the TypeType metatype, named OclType.
 org.eclipse.uml2.uml.Classifier getOclVoid()
          Obtains the single instance of the VoidType metatype, named OclVoid.
 org.eclipse.uml2.uml.Classifier getOrderedSet()
          Obtains the generic instance of the OrderedSetType metatype, named OrderedSet(T).
 org.eclipse.uml2.uml.Classifier getReal()
          Obtains the instance of the PrimitiveType metatype, named Real.
 org.eclipse.uml2.uml.Classifier getSequence()
          Obtains the generic instance of the SequenceType metatype, named Sequence(T).
 org.eclipse.uml2.uml.Classifier getSet()
          Obtains the generic instance of the SetType metatype, named Set(T).
 org.eclipse.uml2.uml.Classifier getState()
          Obtains the instance of the ElementType metatype that represents the type of states in the model, named State.
 org.eclipse.uml2.uml.Classifier getString()
          Obtains the instance of the PrimitiveType metatype, named String.
 org.eclipse.uml2.uml.Classifier getT()
          Obtains a generic instance of the AnyType metatype that represents the type parameter of generic types and operations, named T.
 org.eclipse.uml2.uml.Classifier getT2()
          Obtains a generic instance of the AnyType metatype that represents another type parameter of generic operations (particularly certain OCL Collection operations), named T2.
 org.eclipse.uml2.uml.Classifier getUnlimitedNatural()
          Obtains the instance of the PrimitiveType metatype, named UnlimitedNatural.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UMLOCLStandardLibrary

public UMLOCLStandardLibrary()
Method Detail

getBag

public org.eclipse.uml2.uml.Classifier getBag()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the BagType metatype, named Bag(T).

Specified by:
getBag in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Bag(T) type (an instance of BagType)

getBoolean

public org.eclipse.uml2.uml.Classifier getBoolean()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the PrimitiveType metatype, named Boolean.

Specified by:
getBoolean in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Boolean type (an instance of PrimitiveType)

getCollection

public org.eclipse.uml2.uml.Classifier getCollection()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the CollectionType metatype, named Collection(T).

Specified by:
getCollection in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Collection(T) type (an instance of CollectionType)

getInteger

public org.eclipse.uml2.uml.Classifier getInteger()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the PrimitiveType metatype, named Integer.

Specified by:
getInteger in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Integer type (an instance of PrimitiveType)

getOclInvalid

public org.eclipse.uml2.uml.Classifier getOclInvalid()
Description copied from interface: OCLStandardLibrary
Obtains the single instance of the InvalidType metatype, named OclInvalid.

Specified by:
getOclInvalid in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclInvalid type (an instance of InvalidType)
Since:
3.0

getOclAny

public org.eclipse.uml2.uml.Classifier getOclAny()
Description copied from interface: OCLStandardLibrary
Obtains the single instance of the AnyType metatype, named OclAny.

Specified by:
getOclAny in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclAny type (an instance of AnyType)

getOclElement

public org.eclipse.uml2.uml.Classifier getOclElement()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the ElementType metatype, named OclElement.

Specified by:
getOclElement in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclElement type (an instance of ElementType)

getOclExpression

public org.eclipse.uml2.uml.Classifier getOclExpression()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the ElementType metatype that represents the type of OCL expressions in the model, named OclExpression.

Specified by:
getOclExpression in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclExpression type (an instance of ElementType)

getInvalid

public java.lang.Object getInvalid()
Description copied from interface: OCLStandardLibrary
Obtains the single instance of the OclInvalid type, identified by the token invalid.

Specified by:
getInvalid in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the invalid instance (an instance of invalid)

getOclMessage

public org.eclipse.uml2.uml.Classifier getOclMessage()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the MessageType metatype, named OclMessage.

Specified by:
getOclMessage in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclMessage type (an instance of MessageType)

getOclType

public org.eclipse.uml2.uml.Classifier getOclType()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the TypeType metatype, named OclType.

Specified by:
getOclType in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclType type (an instance of TypeType)

getOclVoid

public org.eclipse.uml2.uml.Classifier getOclVoid()
Description copied from interface: OCLStandardLibrary
Obtains the single instance of the VoidType metatype, named OclVoid.

Specified by:
getOclVoid in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OclVoid type (an instance of VoidType)

getOrderedSet

public org.eclipse.uml2.uml.Classifier getOrderedSet()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the OrderedSetType metatype, named OrderedSet(T).

Specified by:
getOrderedSet in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the OrderedSet(T) type (an instance of OrderedSetType)

getReal

public org.eclipse.uml2.uml.Classifier getReal()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the PrimitiveType metatype, named Real.

Specified by:
getReal in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Real type (an instance of PrimitiveType)

getSequence

public org.eclipse.uml2.uml.Classifier getSequence()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the SequenceType metatype, named Sequence(T).

Specified by:
getSequence in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Sequence(T) type (an instance of SequenceType)

getSet

public org.eclipse.uml2.uml.Classifier getSet()
Description copied from interface: OCLStandardLibrary
Obtains the generic instance of the SetType metatype, named Set(T).

Specified by:
getSet in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the Set(T) type (an instance of SetType)

getState

public org.eclipse.uml2.uml.Classifier getState()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the ElementType metatype that represents the type of states in the model, named State.

Specified by:
getState in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the State type (an instance of ElementType)

getString

public org.eclipse.uml2.uml.Classifier getString()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the PrimitiveType metatype, named String.

Specified by:
getString in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the String type (an instance of PrimitiveType)

getT

public org.eclipse.uml2.uml.Classifier getT()
Description copied from interface: OCLStandardLibrary
Obtains a generic instance of the AnyType metatype that represents the type parameter of generic types and operations, named T.

Specified by:
getT in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the T type parameter (an instance of AnyType)

getT2

public org.eclipse.uml2.uml.Classifier getT2()
Description copied from interface: OCLStandardLibrary
Obtains a generic instance of the AnyType metatype that represents another type parameter of generic operations (particularly certain OCL Collection operations), named T2.

Specified by:
getT2 in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the T2 type parameter (an instance of AnyType)

getUnlimitedNatural

public org.eclipse.uml2.uml.Classifier getUnlimitedNatural()
Description copied from interface: OCLStandardLibrary
Obtains the instance of the PrimitiveType metatype, named UnlimitedNatural.

Specified by:
getUnlimitedNatural in interface OCLStandardLibrary<org.eclipse.uml2.uml.Classifier>
Returns:
the UnlimitedNatural type (an instance of PrimitiveType)

getOCLStdLibPackage

public org.eclipse.uml2.uml.Package getOCLStdLibPackage()
Returns:
the Package which contains the OCL predefined types.