org.eclipse.uml2.uml
Interface Signal

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

public interface Signal
extends Classifier

A representation of the model object 'Signal'. A signal is a specification of send request instances communicated between objects. The receiving object handles the received request instances as specified by its receptions. The data carried by a send request (which was passed to it by the send invocation occurrence that caused that request) are represented as attributes of the signal. A signal is defined independently of the classifiers handling the signal occurrence.

The following features are supported:

See Also:
UMLPackage.getSignal()

Field Summary
 
Fields inherited from interface org.eclipse.uml2.uml.NamedElement
SEPARATOR
 
Method Summary
 Property createOwnedAttribute(String name, Type type)
          Creates a new Property, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list
 Property createOwnedAttribute(String name, Type type, EClass eClass)
          Creates a new Property, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list
 Property createOwnedAttribute(String name, Type type, int lower, int upper)
           Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this signal
 Property getOwnedAttribute(String name, Type type)
          Retrieves the first Property with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list
 Property getOwnedAttribute(String name, Type type, boolean ignoreCase, EClass eClass, boolean createOnDemand)
          Retrieves the first Property with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list
 EList getOwnedAttributes()
          Returns the value of the 'Owned Attribute' containment reference list.
 
Methods inherited from interface org.eclipse.uml2.uml.Classifier
allFeatures, allParents, conformsTo, createCollaborationUse, createGeneralization, createOwnedUseCase, createRepresentation, createSubstitution, getAllAttributes, getAllOperations, getAllUsedInterfaces, getAttribute, getAttribute, getAttributes, getCollaborationUse, getCollaborationUse, getCollaborationUses, getFeature, getFeature, getFeatures, getGeneral, getGeneral, getGeneralization, getGeneralization, getGeneralizations, getGenerals, getInheritedMember, getInheritedMember, getInheritedMembers, getOperation, getOperation, getOperations, getOwnedUseCase, getOwnedUseCase, getOwnedUseCases, getPowertypeExtent, getPowertypeExtent, getPowertypeExtents, getRedefinedClassifier, getRedefinedClassifier, getRedefinedClassifiers, getRepresentation, getSubstitution, getSubstitution, getSubstitutions, getUseCase, getUseCase, getUseCases, getUsedInterfaces, hasVisibilityOf, inherit, inheritableMembers, isAbstract, maySpecializeType, parents, setIsAbstract, setRepresentation, validateGeneralizationHierarchies, validateMapsToGeneralizationSet, validateNoCyclesInGeneralization, validateSpecializeType
 
Methods inherited from interface org.eclipse.uml2.uml.Namespace
createElementImport, createElementImport, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImport, getElementImport, getElementImports, getImportedElements, getImportedMember, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMember, getMembers, getNamesOfMember, getOwnedMember, getOwnedMember, getOwnedMembers, getOwnedRule, getOwnedRule, getOwnedRules, getPackageImport, getPackageImport, getPackageImports, importMembers, membersAreDistinguishable, validateMembersDistinguishable
 
Methods inherited from interface org.eclipse.uml2.uml.NamedElement
allNamespaces, allOwningPackages, createDependency, createNameExpression, getClientDependencies, getClientDependency, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, isSetName, isSetVisibility, separator, setName, setNameExpression, setVisibility, unsetName, unsetVisibility, validateHasNoQualifiedName, validateHasQualifiedName, validateVisibilityNeedsOwnership
 
Methods inherited from interface org.eclipse.uml2.uml.Element
addKeyword, allOwnedElements, applyStereotype, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedSubstereotype, getAppliedSubstereotypes, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getRelationships, getRelationships, getRequiredStereotype, getRequiredStereotypes, getSourceDirectedRelationships, getSourceDirectedRelationships, getStereotypeApplication, getStereotypeApplications, getTargetDirectedRelationships, getTargetDirectedRelationships, getValue, hasKeyword, hasValue, isStereotypeApplicable, isStereotypeApplied, isStereotypeRequired, mustBeOwned, removeKeyword, setValue, unapplyStereotype, 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.uml.RedefinableElement
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid
 
Methods inherited from interface org.eclipse.uml2.uml.Type
conformsTo, createAssociation, getAssociations, getPackage, setPackage
 
Methods inherited from interface org.eclipse.uml2.uml.ParameterableElement
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter
 
Methods inherited from interface org.eclipse.uml2.uml.TemplateableElement
createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBinding, getTemplateBinding, getTemplateBindings, isTemplate, parameterableElements, setOwnedTemplateSignature
 

Method Detail

getOwnedAttributes

public EList getOwnedAttributes()
Returns the value of the 'Owned Attribute' containment reference list. The list contents are of type Property. The attributes owned by the signal.

Returns:
the value of the 'Owned Attribute' containment reference list.
See Also:
UMLPackage.getSignal_OwnedAttribute()

createOwnedAttribute

public Property createOwnedAttribute(String name,
                                     Type type,
                                     EClass eClass)
Creates a new Property, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.

Parameters:
name - The 'Name' for the new Property, or null.
type - The 'Type' for the new Property, or null.
eClass - The Ecore class of the Property to create.
Returns:
The new Property.
See Also:
Signal.getOwnedAttributes()

createOwnedAttribute

public Property createOwnedAttribute(String name,
                                     Type type)
Creates a new Property, with the specified 'Name', and 'Type', and appends it to the 'Owned Attribute' containment reference list.

Parameters:
name - The 'Name' for the new Property, or null.
type - The 'Type' for the new Property, or null.
Returns:
The new Property.
See Also:
Signal.getOwnedAttributes()

getOwnedAttribute

public Property getOwnedAttribute(String name,
                                  Type type)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.

Parameters:
name - The 'Name' of the Property to retrieve, or null.
type - The 'Type' of the Property to retrieve, or null.
Returns:
The first Property with the specified 'Name', and 'Type', or null.
See Also:
Signal.getOwnedAttributes()

getOwnedAttribute

public Property getOwnedAttribute(String name,
                                  Type type,
                                  boolean ignoreCase,
                                  EClass eClass,
                                  boolean createOnDemand)
Retrieves the first Property with the specified 'Name', and 'Type' from the 'Owned Attribute' containment reference list.

Parameters:
name - The 'Name' of the Property to retrieve, or null.
type - The 'Type' of the Property to retrieve, or null.
ignoreCase - Whether to ignore case in String comparisons.
eClass - The Ecore class of the Property to retrieve, or null.
createOnDemand - Whether to create a Property on demand if not found.
Returns:
The first Property with the specified 'Name', and 'Type', or null.
See Also:
Signal.getOwnedAttributes()

createOwnedAttribute

public Property createOwnedAttribute(String name,
                                     Type type,
                                     int lower,
                                     int upper)
Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this signal.


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