|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A representation of the model object 'Port'. Ports represent interaction points between a classifier and its environment. The interfaces associated with a port specify the nature of the interactions that may occur over a port. The required interfaces of a port characterize the requests which may be made from the classifier to its environment through this port. The provided interfaces of a port characterize requests to the classifier that its environment may make through this port. A port has the ability to specify that any requests arriving at this port are handled by the behavior of the instance of the owning classifier, rather than being forwarded to any contained instances, if any.
The following features are supported:
UML2Package.getPort()
Field Summary | |
static String |
copyright
|
Fields inherited from interface org.eclipse.uml2.NamedElement |
SEPARATOR |
Fields inherited from interface org.eclipse.uml2.MultiplicityElement |
UNLIMITED_UPPER_BOUND |
Method Summary | |
ProtocolStateMachine |
getProtocol()
Returns the value of the 'Protocol' reference |
Interface |
getProvided(String unqualifiedName)
Retrieves the Interface with the specified name from the 'Provided' reference list |
EList |
getProvideds()
Returns the value of the 'Provided' reference list. |
EList |
getRedefinedElements()
|
Port |
getRedefinedPort(String unqualifiedName)
Retrieves the Port with the specified name from the 'Redefined Port' reference list |
EList |
getRedefinedPorts()
Returns the value of the 'Redefined Port' reference list. |
Interface |
getRequired(String unqualifiedName)
Retrieves the Interface with the specified name from the 'Required' reference list |
EList |
getRequireds()
Returns the value of the 'Required' reference list. |
boolean |
isBehavior()
Returns the value of the 'Is Behavior' attribute. |
boolean |
isService()
Returns the value of the 'Is Service' attribute. |
void |
setIsBehavior(boolean value)
Sets the value of the ' Is Behavior ' attribute |
void |
setIsService(boolean value)
Sets the value of the ' Is Service ' attribute |
void |
setProtocol(ProtocolStateMachine value)
Sets the value of the ' Protocol ' reference |
Methods inherited from interface org.eclipse.uml2.Feature |
getFeaturingClassifier, isStatic, setIsStatic |
Methods inherited from interface org.eclipse.uml2.RedefinableElement |
getRedefinitionContext, getRedefinitionContexts, isLeaf, isRedefinitionContextValid, setIsLeaf, validateRedefinitionConsistent, validateRedefinitionContextValid |
Methods inherited from interface org.eclipse.uml2.NamedElement |
allNamespaces, createNameExpression, getClientDependencies, getClientDependency, getName, getNameExpression, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership |
Methods inherited from interface org.eclipse.uml2.TemplateableElement |
createOwnedTemplateSignature, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature |
Methods inherited from interface org.eclipse.uml2.Element |
addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getValue, hasKeyword, 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.TypedElement |
getType, setType |
Methods inherited from interface org.eclipse.uml2.MultiplicityElement |
createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesCardinality, includesMultiplicity, isMultivalued, isOrdered, isUnique, lower, lowerBound, setIsOrdered, setIsUnique, setLowerBound, setLowerValue, setUpperBound, setUpperValue, upper, upperBound, validateLowerEqLowerbound, validateLowerGe0, validateUpperEqUpperbound, validateUpperGeLower, validateUpperGt0 |
Methods inherited from interface org.eclipse.uml2.ConnectableElement |
getEnds |
Methods inherited from interface org.eclipse.uml2.ParameterableElement |
getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.DeploymentTarget |
createDeployment, getClientDependencies, getDeployedElement, getDeployedElements, getDeployment, getDeployments |
Field Detail |
public static final String copyright
Method Detail |
public boolean isBehavior()
"false"
.
If the meaning of the 'Is Behavior' attribute isn't clear, there really should be more of a description here...
Specifies whether requests arriving at this port are sent to the classifier behavior of this classifier (see �BehavioredClassifier (from BasicBehaviors)� on page 387). Such ports are referred to as behavior port. Any invocation of a behavioral feature targeted at a behavior port will be handled by the instance of the owning classifier itself, rather than by any instances that this classifier may contain. The default value is false.
setIsBehavior(boolean)
,
UML2Package.getPort_IsBehavior()
public void setIsBehavior(boolean value)
Is Behavior
' attribute.
value
- the new value of the 'Is Behavior' attribute.isBehavior()
public boolean isService()
"true"
.
If the meaning of the 'Is Service' attribute isn't clear, there really should be more of a description here...
If true indicates that this port is used to provide the published functionality of a classifier; if false, this port is used to implement the classifier but is not part of the essential externally- visible functionality of the classifier and can, therefore, be altered or deleted along with the internal implementation of the classifier and other properties that are considered part of its implementation. The default value for this attribute is true.
setIsService(boolean)
,
UML2Package.getPort_IsService()
public void setIsService(boolean value)
Is Service
' attribute.
value
- the new value of the 'Is Service' attribute.isService()
public EList getRequireds()
Interface
.
If the meaning of the 'Required' reference list isn't clear, there really should be more of a description here...
References the interfaces specifying the set of operations and receptions which the classifier expects its environment to handle. This association is derived as the set of interfaces required by the type of the port or its supertypes.
UML2Package.getPort_Required()
public Interface getRequired(String unqualifiedName)
Interface
with the specified name from the 'Required' reference list.
unqualifiedName
- The unqualified name of the Interface
to retrieve.
Interface
with the specified name, or null
.getRequireds()
public EList getRedefinedPorts()
Port
.
If the meaning of the 'Redefined Port' reference list isn't clear, there really should be more of a description here...
A port may be redefined when its containing classifier is specialized. The redefining port may have additional interfaces to those that are associated with the redefined port or it may replace an interface by one of its subtypes. (Subsets Element.redefinedElement.)
UML2Package.getPort_RedefinedPort()
public Port getRedefinedPort(String unqualifiedName)
Port
with the specified name from the 'Redefined Port' reference list.
unqualifiedName
- The unqualified name of the Port
to retrieve.
Port
with the specified name, or null
.getRedefinedPorts()
public EList getProvideds()
Interface
.
If the meaning of the 'Provided' reference list isn't clear, there really should be more of a description here...
References the interfaces specifying the set of operations and receptions which the classifier offers to its environment, and which it will handle either directly or by forwarding it to a part of its internal structure. This association is derived from the interfaces realized by the type of the port or by the type of the port, if the port was typed by an interface.
UML2Package.getPort_Provided()
public Interface getProvided(String unqualifiedName)
Interface
with the specified name from the 'Provided' reference list.
unqualifiedName
- The unqualified name of the Interface
to retrieve.
Interface
with the specified name, or null
.getProvideds()
public ProtocolStateMachine getProtocol()
If the meaning of the 'Protocol' reference isn't clear, there really should be more of a description here...
References an optional protocol state machine which describes valid interactions at this interaction point.
setProtocol(ProtocolStateMachine)
,
UML2Package.getPort_Protocol()
public void setProtocol(ProtocolStateMachine value)
Protocol
' reference.
value
- the new value of the 'Protocol' reference.getProtocol()
public EList getRedefinedElements()
getRedefinedElements
in interface Property
|
Copyright 2003, 2004 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |