org.eclipse.uml2
Interface Enumeration

All Superinterfaces:
Classifier, DataType, Element, EModelElement, EObject, NamedElement, Namespace, Notifier, PackageableElement, ParameterableElement, RedefinableElement, TemplateableElement, Type

public interface Enumeration
extends DataType

A representation of the model object 'Enumeration'. Enumeration is a kind of data type, whose instances may be any of a number of user-defined enumeration literals. It is possible to extend the set of applicable enumeration literals in other packages or profiles.

The following features are supported:

See Also:
UML2Package.getEnumeration()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 EnumerationLiteral createOwnedLiteral()
          Creates a EnumerationLiteral and appends it to the 'Owned Literal' containment reference list
 EnumerationLiteral createOwnedLiteral(EClass eClass)
          Deprecated. Use #createOwnedLiteral() instead.
 EnumerationLiteral createOwnedLiteral(java.lang.String name)
          Creates an enumeration literal with the specified name as an owned literal of this enumeration.
 EnumerationLiteral getOwnedLiteral(java.lang.String name)
          Retrieves the EnumerationLiteral with the specified 'Name' from the 'Owned Literal' containment reference list
 EList getOwnedLiterals()
          Returns the value of the 'Owned Literal' containment reference list.
 
Methods inherited from interface org.eclipse.uml2.DataType
createOwnedAttribute, createOwnedAttribute, createOwnedAttribute, createOwnedOperation, createOwnedOperation, createOwnedOperation, getOwnedAttribute, getOwnedAttributes, getOwnedOperation, getOwnedOperations
 
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
 

Field Detail

copyright

public static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getOwnedLiterals

public EList getOwnedLiterals()
Returns the value of the 'Owned Literal' containment reference list. The list contents are of type EnumerationLiteral. It is bidirectional and its opposite is 'Enumeration'.

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

ordered set of literals for this Enumeration. Subsets Element::ownedMember.

Returns:
the value of the 'Owned Literal' containment reference list.
See Also:
UML2Package.getEnumeration_OwnedLiteral(), EnumerationLiteral.getEnumeration()

getOwnedLiteral

public EnumerationLiteral getOwnedLiteral(java.lang.String name)
Retrieves the EnumerationLiteral with the specified 'Name' from the 'Owned Literal' containment reference list.

Parameters:
name - The 'Name' of the EnumerationLiteral to retrieve.
Returns:
The EnumerationLiteral with the specified 'Name', or null.
See Also:
getOwnedLiterals()

createOwnedLiteral

public EnumerationLiteral createOwnedLiteral(EClass eClass)
Deprecated. Use #createOwnedLiteral() instead.

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

Parameters:
eClass - The Ecore class of the EnumerationLiteral to create.
Returns:
The new EnumerationLiteral.
See Also:
getOwnedLiterals()

createOwnedLiteral

public EnumerationLiteral createOwnedLiteral()
Creates a EnumerationLiteral and appends it to the 'Owned Literal' containment reference list.

Returns:
The new EnumerationLiteral.
See Also:
getOwnedLiterals()

createOwnedLiteral

public EnumerationLiteral createOwnedLiteral(java.lang.String name)
Creates an enumeration literal with the specified name as an owned literal of this enumeration.

Parameters:
name - The name for the owned literal.
Returns:
The new enumeration literal.
Throws:
java.lang.IllegalArgumentException - If the name is empty.

Copyright 2003, 2005 IBM Corporation and others.
All Rights Reserved.