|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Port
A representation of the model object 'Port'. A port has an associated protocol state machine. A port is a property of a classifier that specifies a distinct interaction point between that classifier and its environment or between the (behavior of the) classifier and its internal parts. Ports are connected to properties of the classifier by connectors through which requests can be made to invoke the behavioral features of a classifier. A Port may specify the services a classifier provides (offers) to its environment as well as the services that a classifier expects (requires) of its environment.
The following features are supported:
UMLPackage.getPort()
Field Summary |
---|
Fields inherited from interface org.eclipse.uml2.uml.NamedElement |
---|
SEPARATOR |
Method Summary | |
---|---|
ProtocolStateMachine |
getProtocol()
Returns the value of the 'Protocol' reference |
Interface |
getProvided(java.lang.String name)
Retrieves the first Interface with the specified 'Name' from the 'Provided' reference list |
Interface |
getProvided(java.lang.String name,
boolean ignoreCase)
Retrieves the first Interface with the specified 'Name' from the 'Provided' reference list |
org.eclipse.emf.common.util.EList<Interface> |
getProvideds()
Returns the value of the 'Provided' reference list. |
Port |
getRedefinedPort(java.lang.String name,
Type type)
Retrieves the first Port with the specified 'Name', and 'Type' from the 'Redefined Port' reference list |
Port |
getRedefinedPort(java.lang.String name,
Type type,
boolean ignoreCase)
Retrieves the first Port with the specified 'Name', and 'Type' from the 'Redefined Port' reference list |
org.eclipse.emf.common.util.EList<Port> |
getRedefinedPorts()
Returns the value of the 'Redefined Port' reference list. |
Interface |
getRequired(java.lang.String name)
Retrieves the first Interface with the specified 'Name' from the 'Required' reference list |
Interface |
getRequired(java.lang.String name,
boolean ignoreCase)
Retrieves the first Interface with the specified 'Name' from the 'Required' reference list |
org.eclipse.emf.common.util.EList<Interface> |
getRequireds()
Returns the value of the 'Required' reference list. |
boolean |
isBehavior()
Returns the value of the 'Is Behavior' attribute. |
boolean |
isConjugated()
Returns the value of the 'Is Conjugated' attribute. |
boolean |
isService()
Returns the value of the 'Is Service' attribute. |
void |
setIsBehavior(boolean value)
Sets the value of the ' Is Behavior ' attribute |
void |
setIsConjugated(boolean value)
Sets the value of the ' Is Conjugated ' attribute |
void |
setIsService(boolean value)
Sets the value of the ' Is Service ' attribute |
void |
setProtocol(ProtocolStateMachine value)
Sets the value of the ' Protocol ' reference |
boolean |
validateDefaultValue(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
A defaultValue for port cannot be specified when the type of the Port is an Interface true |
boolean |
validatePortAggregation(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
Port.aggregation must be composite. |
boolean |
validatePortDestroyed(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
java.util.Map<java.lang.Object,java.lang.Object> context)
When a port is destroyed, all connectors attached to this port will be destroyed also. |
Methods inherited from interface org.eclipse.uml2.uml.StructuralFeature |
---|
isReadOnly, setIsReadOnly |
Methods inherited from interface org.eclipse.uml2.uml.Feature |
---|
getFeaturingClassifier, getFeaturingClassifier, getFeaturingClassifiers, isStatic, setIsStatic |
Methods inherited from interface org.eclipse.uml2.uml.RedefinableElement |
---|
getRedefinedElement, getRedefinedElement, getRedefinedElements, getRedefinitionContext, getRedefinitionContext, getRedefinitionContexts, isConsistentWith, isLeaf, isRedefinitionContextValid, setIsLeaf, validateNonLeafRedefinition, validateRedefinitionConsistent, validateRedefinitionContextValid |
Methods inherited from interface org.eclipse.uml2.uml.NamedElement |
---|
allNamespaces, allOwningPackages, createDependency, createNameExpression, createUsage, 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.emf.ecore.EModelElement |
---|
getEAnnotation, getEAnnotations |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
---|
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, 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.MultiplicityElement |
---|
compatibleWith, createLowerValue, createUpperValue, getLower, getLowerValue, getUpper, getUpperValue, includesCardinality, includesMultiplicity, is, isMultivalued, isOrdered, isUnique, lowerBound, setIsOrdered, setIsUnique, setLower, setLowerValue, setUpper, setUpperValue, upperBound, validateLowerGe0, validateUpperGeLower, validateValueSpecificationConstant, validateValueSpecificationNoSideEffects |
Methods inherited from interface org.eclipse.uml2.uml.ConnectableElement |
---|
getEnds |
Methods inherited from interface org.eclipse.uml2.uml.TypedElement |
---|
getType, setType |
Methods inherited from interface org.eclipse.uml2.uml.ParameterableElement |
---|
getOwningTemplateParameter, getTemplateParameter, isCompatibleWith, isTemplateParameter, setOwningTemplateParameter, setTemplateParameter |
Methods inherited from interface org.eclipse.uml2.uml.DeploymentTarget |
---|
createDeployment, getDeployedElement, getDeployedElement, getDeployedElements, getDeployment, getDeployment, getDeployments |
Method Detail |
---|
boolean isBehavior()
"false"
.
Specifies whether requests arriving at this port are sent to the classifier behavior of this classifier. 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.
setIsBehavior(boolean)
,
UMLPackage.getPort_IsBehavior()
void setIsBehavior(boolean value)
Is Behavior
' attribute.
value
- the new value of the 'Is Behavior' attribute.isBehavior()
boolean isConjugated()
"false"
.
Specifies the way that the provided and required interfaces are derived from the Port’s Type. The default value is false.
setIsConjugated(boolean)
,
UMLPackage.getPort_IsConjugated()
void setIsConjugated(boolean value)
Is Conjugated
' attribute.
value
- the new value of the 'Is Conjugated' attribute.isConjugated()
boolean isService()
"true"
.
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.
setIsService(boolean)
,
UMLPackage.getPort_IsService()
void setIsService(boolean value)
Is Service
' attribute.
value
- the new value of the 'Is Service' attribute.isService()
org.eclipse.emf.common.util.EList<Interface> getRequireds()
Interface
.
References the interfaces specifying the set of operations and receptions that the classifier expects its environment to handle via this port. This association is derived according to the value of isConjugated. If isConjugated is false, required is derived as the union of the sets of interfaces used by the type of the port and its supertypes. If isConjugated is true, it is derived as the union of the sets of interfaces realized by the type of the port and its supertypes, or directly from the type of the port if the port is typed by an interface.
UMLPackage.getPort_Required()
Interface getRequired(java.lang.String name)
Interface
with the specified 'Name' from the 'Required' reference list.
name
- The 'Name' of the Interface
to retrieve, or null
.
Interface
with the specified 'Name', or null
.getRequireds()
Interface getRequired(java.lang.String name, boolean ignoreCase)
Interface
with the specified 'Name' from the 'Required' reference list.
name
- The 'Name' of the Interface
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.
Interface
with the specified 'Name', or null
.getRequireds()
org.eclipse.emf.common.util.EList<Port> getRedefinedPorts()
Port
.
This feature subsets the following features:
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.
UMLPackage.getPort_RedefinedPort()
Port getRedefinedPort(java.lang.String name, Type type)
Port
with the specified 'Name', and 'Type' from the 'Redefined Port' reference list.
name
- The 'Name' of the Port
to retrieve, or null
.type
- The 'Type' of the Port
to retrieve, or null
.
Port
with the specified 'Name', and 'Type', or null
.getRedefinedPorts()
Port getRedefinedPort(java.lang.String name, Type type, boolean ignoreCase)
Port
with the specified 'Name', and 'Type' from the 'Redefined Port' reference list.
name
- The 'Name' of the Port
to retrieve, or null
.type
- The 'Type' of the Port
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.
Port
with the specified 'Name', and 'Type', or null
.getRedefinedPorts()
org.eclipse.emf.common.util.EList<Interface> getProvideds()
Interface
.
References the interfaces specifying the set of operations and receptions that the classifier offers to its environment via this port, and which it will handle either directly or by forwarding it to a part of its internal structure. This association is derived according to the value of isConjugated. If isConjugated is false, provided is derived as the union of the sets of interfaces realized by the type of the port and its supertypes, or directly from the type of the port if the port is typed by an interface. If isConjugated is true, it is derived as the union of the sets of interfaces used by the type of the port and its supertypes.
UMLPackage.getPort_Provided()
Interface getProvided(java.lang.String name)
Interface
with the specified 'Name' from the 'Provided' reference list.
name
- The 'Name' of the Interface
to retrieve, or null
.
Interface
with the specified 'Name', or null
.getProvideds()
Interface getProvided(java.lang.String name, boolean ignoreCase)
Interface
with the specified 'Name' from the 'Provided' reference list.
name
- The 'Name' of the Interface
to retrieve, or null
.ignoreCase
- Whether to ignore case in String
comparisons.
Interface
with the specified 'Name', or null
.getProvideds()
ProtocolStateMachine getProtocol()
setProtocol(ProtocolStateMachine)
,
UMLPackage.getPort_Protocol()
void setProtocol(ProtocolStateMachine value)
Protocol
' reference.
value
- the new value of the 'Protocol' reference.getProtocol()
boolean validatePortAggregation(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validatePortDestroyed(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
boolean validateDefaultValue(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context)
diagnostics
- The chain of diagnostics to which problems are to be appended.context
- The cache of context-specific information.
|
Copyright 2003, 2012 IBM Corporation, CEA, and others. All Rights Reserved. |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |