org.eclipse.uml2
Interface Component

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

public interface Component
extends Class

A representation of the model object 'Component'.

The following features are supported:

See Also:
UML2Package.getComponent()

Field Summary
static java.lang.String copyright
           
 
Fields inherited from interface org.eclipse.uml2.NamedElement
SEPARATOR
 
Method Summary
 Class createOwnedClass(java.lang.String name, boolean isAbstract)
          Creates a(n) (abstract) class with the specified name as an owned member of this component.
 Enumeration createOwnedEnumeraton(java.lang.String name)
          Creates an enumeration with the specified name as an owned member of this component.
 PackageableElement createOwnedMember(EClass eClass)
          Creates a PackageableElement and appends it to the 'Owned Member' containment reference list
 Package createOwnedPackage(java.lang.String name)
          Creates a package with the specified name as an owned member of this component.
 PrimitiveType createOwnedPrimitiveType(java.lang.String name)
          Creates a primitive type with the specified name as an owned member of this component.
 Realization createRealization()
          Creates a Realization and appends it to the 'Realization' containment reference list
 Realization createRealization(EClass eClass)
          Creates a Realization and appends it to the 'Realization' containment reference list
 NamedElement getOwnedMember(java.lang.String name)
          Retrieves the PackageableElement with the specified 'Name' from the 'Owned Member' containment reference list
 EList getOwnedMembers()
          Returns the value of the 'Owned Member' containment reference list.
 Interface getProvided(java.lang.String name)
          Retrieves the Interface with the specified 'Name' from the 'Provided' reference list
 EList getProvideds()
          Returns the value of the 'Provided' reference list.
 Realization getRealization(java.lang.String name)
          Retrieves the Realization with the specified 'Name' from the 'Realization' containment reference list
 EList getRealizations()
          Returns the value of the 'Realization' containment reference list.
 Interface getRequired(java.lang.String name)
          Retrieves the Interface with the specified 'Name' from the 'Required' reference list
 EList getRequireds()
          Returns the value of the 'Required' reference list.
 boolean isIndirectlyInstantiated()
          Returns the value of the 'Is Indirectly Instantiated' attribute
 void setIsIndirectlyInstantiated(boolean value)
          Sets the value of the 'Is Indirectly Instantiated' attribute
 
Methods inherited from interface org.eclipse.uml2.Class
createNestedClassifier, createOwnedAttribute, createOwnedOperation, createOwnedOperation, createOwnedOperation, createOwnedReception, createOwnedReception, getExtension, getExtensions, getNestedClassifier, getNestedClassifiers, getOwnedOperation, getOwnedOperations, getOwnedReception, getOwnedReceptions, getSuperClass, getSuperClasses, isActive, isMetaclass, setIsActive
 
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, 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

isIndirectlyInstantiated

public boolean isIndirectlyInstantiated()
Returns the value of the 'Is Indirectly Instantiated' attribute.

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

{default = true} The kind of instantiation that applies to a Component. If false, the component is instantiated as an addressable object. If true, the Component is defined at design-time, but at runtime (or execution-time) an object specified by the Component does not exist, that is, the component is instantiated indirectly, through the instantiation of its realizing classifiers or parts. Several standard stereotypes use this meta attribute, e.g. �specification, �focus�, �subsystem �.

Returns:
the value of the 'Is Indirectly Instantiated' attribute.
See Also:
setIsIndirectlyInstantiated(boolean), UML2Package.getComponent_IsIndirectlyInstantiated()

setIsIndirectlyInstantiated

public void setIsIndirectlyInstantiated(boolean value)
Sets the value of the 'Is Indirectly Instantiated' attribute.

Parameters:
value - the new value of the 'Is Indirectly Instantiated' attribute.
See Also:
isIndirectlyInstantiated()

getRequireds

public EList getRequireds()
Returns the value of the 'Required' reference list. The list contents are of type Interface.

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

Returns:
the value of the 'Required' reference list.
See Also:
UML2Package.getComponent_Required()

getRequired

public Interface getRequired(java.lang.String name)
Retrieves the Interface with the specified 'Name' from the 'Required' reference list.

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

getProvideds

public EList getProvideds()
Returns the value of the 'Provided' reference list. The list contents are of type Interface.

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

Returns:
the value of the 'Provided' reference list.
See Also:
UML2Package.getComponent_Provided()

getProvided

public Interface getProvided(java.lang.String name)
Retrieves the Interface with the specified 'Name' from the 'Provided' reference list.

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

getRealizations

public EList getRealizations()
Returns the value of the 'Realization' containment reference list. The list contents are of type Realization. It is bidirectional and its opposite is 'Abstraction'.

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

Returns:
the value of the 'Realization' containment reference list.
See Also:
UML2Package.getComponent_Realization(), Realization.getAbstraction()

getRealization

public Realization getRealization(java.lang.String name)
Retrieves the Realization with the specified 'Name' from the 'Realization' containment reference list.

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

createRealization

public Realization createRealization(EClass eClass)
Creates a Realization and appends it to the 'Realization' containment reference list.

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

createRealization

public Realization createRealization()
Creates a Realization and appends it to the 'Realization' containment reference list.

Returns:
The new Realization.
See Also:
getRealizations()

getOwnedMembers

public EList getOwnedMembers()
Returns the value of the 'Owned Member' containment reference list. The list contents are of type PackageableElement.

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

Specified by:
getOwnedMembers in interface Namespace
Returns:
the value of the 'Owned Member' containment reference list.
See Also:
UML2Package.getComponent_OwnedMember()

getOwnedMember

public NamedElement getOwnedMember(java.lang.String name)
Retrieves the PackageableElement with the specified 'Name' from the 'Owned Member' containment reference list.

Specified by:
getOwnedMember in interface Namespace
Parameters:
name - The 'Name' of the PackageableElement to retrieve.
Returns:
The PackageableElement with the specified 'Name', or null.
See Also:
getOwnedMembers()

createOwnedMember

public PackageableElement createOwnedMember(EClass eClass)
Creates a PackageableElement and appends it to the 'Owned Member' containment reference list.

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

createOwnedClass

public Class createOwnedClass(java.lang.String name,
                              boolean isAbstract)
Creates a(n) (abstract) class with the specified name as an owned member of this component.

Parameters:
name - The name for the owned class.
isAbstract - Whether the owned class should be abstract.
Returns:
The new class.
Throws:
java.lang.IllegalArgumentException - If the name is empty.

createOwnedEnumeraton

public Enumeration createOwnedEnumeraton(java.lang.String name)
Creates an enumeration with the specified name as an owned member of this component.

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

createOwnedPackage

public Package createOwnedPackage(java.lang.String name)
Creates a package with the specified name as an owned member of this component.

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

createOwnedPrimitiveType

public PrimitiveType createOwnedPrimitiveType(java.lang.String name)
Creates a primitive type with the specified name as an owned member of this component.

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

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