org.eclipse.uml2
Interface Class

All Superinterfaces:

BehavioredClassifier, Classifier, Element, EModelElement, EncapsulatedClassifier, EObject, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, StructuredClassifier, TemplateableElement, Type

All Known Subinterfaces:

Activity, AssociationClass, Behavior, Component, Device, ExecutionEnvironment, Interaction, Node, ProtocolStateMachine, StateMachine, Stereotype

public interface Class

extends BehavioredClassifier, EncapsulatedClassifier

A representation of the model object 'Class'. Class is a kind of classifier whose features are attributes and operations. Attributes of a class are represented by instances of Property that are owned by the class. Some of these attributes may represent the navigable ends of binary associations.

The following features are supported:

• Owned Operation
• Super Class
• Extension
• Nested Classifier
• Is Active
• Owned Reception

See Also:

UML2Package.getClass_()

Field Summary

static java.lang.String

copyright

Fields inherited from interface org.eclipse.uml2.NamedElement

SEPARATOR

Method Summary

Classifier	createNestedClassifier(EClass eClass) Creates a Classifier and appends it to the 'Nested Classifier' containment reference list
Property	createOwnedAttribute(java.lang.String name, Type type, int lowerBound, int upperBound) Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this class.
Operation	createOwnedOperation() Creates a Operation and appends it to the 'Owned Operation' containment reference list
Operation	createOwnedOperation(EClass eClass) Deprecated. Use #createOwnedOperation() instead.
Operation	createOwnedOperation(java.lang.String name, Type returnType, java.lang.String[] parameterNames, Type[] parameterTypes) Creates an operation with the specified name, return type, parameter names, and parameter types as an owned operation of this class.
Reception	createOwnedReception() Creates a Reception and appends it to the 'Owned Reception' containment reference list
Reception	createOwnedReception(EClass eClass) Deprecated. Use #createOwnedReception() instead.
Extension	getExtension(java.lang.String name) Retrieves the Extension with the specified 'Name' from the 'Extension' reference list
EList	getExtensions() Returns the value of the 'Extension' reference list.
Classifier	getNestedClassifier(java.lang.String name) Retrieves the Classifier with the specified 'Name' from the 'Nested Classifier' containment reference list
EList	getNestedClassifiers() Returns the value of the 'Nested Classifier' containment reference list.
Operation	getOwnedOperation(java.lang.String name) Retrieves the Operation with the specified 'Name' from the 'Owned Operation' containment reference list
EList	getOwnedOperations() Returns the value of the 'Owned Operation' containment reference list.
Reception	getOwnedReception(java.lang.String name) Retrieves the Reception with the specified 'Name' from the 'Owned Reception' containment reference list
EList	getOwnedReceptions() Returns the value of the 'Owned Reception' containment reference list.
Class	getSuperClass(java.lang.String name) Retrieves the Class with the specified 'Name' from the 'Super Class' reference list
EList	getSuperClasses() Returns the value of the 'Super Class' reference list.
boolean	isActive() Returns the value of the 'Is Active' attribute
boolean	isMetaclass() Determines whether this class is a metaclass.
void	setIsActive(boolean value) Sets the value of the 'Is Active' attribute

Methods inherited from interface org.eclipse.uml2.BehavioredClassifier

createImplementation, createImplementation, createImplementation, createOwnedBehavior, createOwnedStateMachine, createOwnedStateMachine, createOwnedTrigger, getAllImplementedInterfaces, getClassifierBehavior, getImplementation, getImplementations, getImplementedInterfaces, getOwnedBehavior, getOwnedBehaviors, getOwnedStateMachine, getOwnedStateMachines, getOwnedTrigger, getOwnedTriggers, setClassifierBehavior

Methods inherited from interface org.eclipse.uml2.Classifier

allFeatures, allParents, conformsTo, createGeneralization, createGeneralization, createGeneralization, createOccurrence, createOccurrence, createOwnedUseCase, createOwnedUseCase, createSubstitution, createSubstitution, general, getAttribute, getAttributes, getFeature, getFeatures, getGeneral, getGeneralizations, getGenerals, getInheritedMember, getInheritedMembers, getOccurrence, getOccurrences, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitutions, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, inheritedMember, isAbstract, maySpecializeType, parents, setIsAbstract, setRepresentation, validateGeneralEqualsParents, validateInheritedMember, validateNoCyclesInGeneralization, validateSpecializeType

Methods inherited from interface org.eclipse.uml2.Namespace

createElementImport, createElementImport, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMembers, getNamesOfMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable

Methods inherited from interface org.eclipse.uml2.NamedElement

allNamespaces, createDependency, createNameExpression, createNameExpression, getClientDependencies, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership

Methods inherited from interface org.eclipse.uml2.TemplateableElement

createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature

Methods inherited from interface org.eclipse.uml2.Element

addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getValue, hasKeyword, hasValue, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf

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

getEAnnotation, getEAnnotations

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

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, 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.uml2.Type

conformsTo, createAssociation, getPackage

Methods inherited from interface org.eclipse.uml2.PackageableElement

getPackageableElement_visibility, setPackageableElement_visibility

Methods inherited from interface org.eclipse.uml2.ParameterableElement

getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter

Methods inherited from interface org.eclipse.uml2.RedefinableElement

getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid

Methods inherited from interface org.eclipse.uml2.EncapsulatedClassifier

createOwnedPort, createOwnedPort, getOwnedPort, getOwnedPorts

Methods inherited from interface org.eclipse.uml2.StructuredClassifier

createOwnedAttribute, createOwnedAttribute, createOwnedConnector, createOwnedConnector, getOwnedAttribute, getOwnedAttributes, getOwnedConnector, getOwnedConnectors, getPart, getParts, getRole, getRoles

Field Detail

copyright

public static final java.lang.String copyright

See Also:

Constant Field Values

Method Detail

isActive

public boolean isActive()

Returns the value of the 'Is Active' attribute.

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

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), UML2Package.getClass_IsActive()

setIsActive

public void setIsActive(boolean value)

Sets the value of the 'Is Active' attribute.

Parameters:

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

See Also:

isActive()

getOwnedOperations

public EList getOwnedOperations()

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

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

The operations owned by the class. The association is ordered. Subsets Classifier::feature and Namespace::ownedMember.

Returns:

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

See Also:

UML2Package.getClass_OwnedOperation(), Operation.getClass_()

getOwnedOperation

public Operation getOwnedOperation(java.lang.String name)

Retrieves the Operation with the specified 'Name' from the 'Owned Operation' containment reference list.

Parameters:

name - The 'Name' of the Operation to retrieve.

Returns:

The Operation with the specified 'Name', or null.

See Also:

getOwnedOperations()

createOwnedOperation

public Operation createOwnedOperation(EClass eClass)

Deprecated. Use #createOwnedOperation() instead.

Creates a Operation and appends it to the 'Owned Operation' containment reference list.

Parameters:

eClass - The Ecore class of the Operation to create.

Returns:

The new Operation.

See Also:

getOwnedOperations()

createOwnedOperation

public Operation createOwnedOperation()

Creates a Operation and appends it to the 'Owned Operation' containment reference list.

Returns:

The new Operation.

See Also:

getOwnedOperations()

getSuperClasses

public EList getSuperClasses()

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

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

This gives the superclasses of a class. It redefines Classifier::general. This is derived.

Returns:

the value of the 'Super Class' reference list.

See Also:

UML2Package.getClass_SuperClass()

getSuperClass

public Class getSuperClass(java.lang.String name)

Retrieves the Class with the specified 'Name' from the 'Super Class' reference list.

Parameters:

name - The 'Name' of the Class to retrieve.

Returns:

The Class with the specified 'Name', or null.

See Also:

getSuperClasses()

getExtensions

public EList getExtensions()

Returns the value of the 'Extension' reference list. The list contents are of type Extension. It is bidirectional and its opposite is 'Metaclass'.

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

Returns:

the value of the 'Extension' reference list.

See Also:

UML2Package.getClass_Extension(), Extension.getMetaclass()

getExtension

public Extension getExtension(java.lang.String name)

Retrieves the Extension with the specified 'Name' from the 'Extension' reference list.

Parameters:

name - The 'Name' of the Extension to retrieve.

Returns:

The Extension with the specified 'Name', or null.

See Also:

getExtensions()

getNestedClassifiers

public EList getNestedClassifiers()

Returns the value of the 'Nested Classifier' containment reference list. The list contents are of type Classifier.

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

References all the Classifiers that are defined (nested) within the Class. Subsets Element:: ownedMember.

Returns:

the value of the 'Nested Classifier' containment reference list.

See Also:

UML2Package.getClass_NestedClassifier()

getNestedClassifier

public Classifier getNestedClassifier(java.lang.String name)

Retrieves the Classifier with the specified 'Name' from the 'Nested Classifier' containment reference list.

Parameters:

name - The 'Name' of the Classifier to retrieve.

Returns:

The Classifier with the specified 'Name', or null.

See Also:

getNestedClassifiers()

createNestedClassifier

public Classifier createNestedClassifier(EClass eClass)

Creates a Classifier and appends it to the 'Nested Classifier' containment reference list.

Parameters:

eClass - The Ecore class of the Classifier to create.

Returns:

The new Classifier.

See Also:

getNestedClassifiers()

getOwnedReceptions

public EList getOwnedReceptions()

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

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

Receptions that objects of this class are willing to accept. (Specializes Namespace.owned- Member and Classifier.feature.)

Returns:

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

See Also:

UML2Package.getClass_OwnedReception()

getOwnedReception

public Reception getOwnedReception(java.lang.String name)

Retrieves the Reception with the specified 'Name' from the 'Owned Reception' containment reference list.

Parameters:

name - The 'Name' of the Reception to retrieve.

Returns:

The Reception with the specified 'Name', or null.

See Also:

getOwnedReceptions()

createOwnedReception

public Reception createOwnedReception(EClass eClass)

Deprecated. Use #createOwnedReception() instead.

Creates a Reception and appends it to the 'Owned Reception' containment reference list.

Parameters:

eClass - The Ecore class of the Reception to create.

Returns:

The new Reception.

See Also:

getOwnedReceptions()

createOwnedReception

public Reception createOwnedReception()

Creates a Reception and appends it to the 'Owned Reception' containment reference list.

Returns:

The new Reception.

See Also:

getOwnedReceptions()

isMetaclass

public boolean isMetaclass()

Determines whether this class is a metaclass.

Returns:

true if this class is stereotyped as a metaclass; false otherwise.

createOwnedAttribute

public Property createOwnedAttribute(java.lang.String name,
                                     Type type,
                                     int lowerBound,
                                     int upperBound)

Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this class.

Parameters:

name - The name for the owned attribute.

type - The type for the owned attribute.

lowerBound - The lower bound for the owned attribute.

upperBound - The upper bound for the owned attribute.

Returns:

The new property.

Throws:

java.lang.IllegalArgumentException - If either of the bounds is invalid.

createOwnedOperation

public Operation createOwnedOperation(java.lang.String name,
                                      Type returnType,
                                      java.lang.String[] parameterNames,
                                      Type[] parameterTypes)

Creates an operation with the specified name, return type, parameter names, and parameter types as an owned operation of this class.

Parameters:

name - The name for the owned operation.

returnType - The return type for the owned operation, or null.

parameterNames - The names of the owned operation's parameters, or null.

parameterTypes - The types of the owned operation's parameters, or null.

Returns:

The new operation.

Throws:

java.lang.IllegalArgumentException - If the number of parameter names does not match the number of parameter types.