org.eclipse.uml2
Interface Interface

All Superinterfaces:

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

public interface Interface

extends Classifier

A representation of the model object 'Interface'. An interface is a kind of classifier that represents a declaration of a set of coherent public features and obligations. In a sense,

The following features are supported:

• Owned Attribute
• Owned Operation
• Redefined Interface
• Nested Classifier
• Owned Reception
• Protocol

See Also:

UML2Package.getInterface()

Field Summary

static java.lang.String

copyright

Fields inherited from interface org.eclipse.uml2.NamedElement

SEPARATOR

Method Summary

Classifier	createNestedClassifier(EClass eClass) Creates a Classifier and appends it to the 'Nested Classifier' containment reference list
Property	createOwnedAttribute() Creates a Property and appends it to the 'Owned Attribute' containment reference list
Property	createOwnedAttribute(EClass eClass) Creates a Property and appends it to the 'Owned Attribute' containment reference list
Property	createOwnedAttribute(java.lang.String name, Type type, int lowerBound, int upperBound) Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this interface.
Operation	createOwnedOperation() Creates a Operation and appends it to the 'Owned Operation' containment reference list
Operation	createOwnedOperation(EClass eClass) Deprecated. Use #createOwnedOperation() instead.
Operation	createOwnedOperation(java.lang.String name, Type returnType, java.lang.String[] parameterNames, Type[] parameterTypes) Creates an operation with the specified name, return type, parameter names, and parameter types as an owned operation of this interface.
Reception	createOwnedReception() Creates a Reception and appends it to the 'Owned Reception' containment reference list
Reception	createOwnedReception(EClass eClass) Deprecated. Use #createOwnedReception() instead.
ProtocolStateMachine	createProtocol() Creates a ProtocolStateMachine and sets the 'Protocol' containment reference
ProtocolStateMachine	createProtocol(EClass eClass) Deprecated. Use #createProtocol() instead.
Classifier	getNestedClassifier(java.lang.String name) Retrieves the Classifier with the specified 'Name' from the 'Nested Classifier' containment reference list
EList	getNestedClassifiers() Returns the value of the 'Nested Classifier' containment reference list.
Property	getOwnedAttribute(java.lang.String name) Retrieves the Property with the specified 'Name' from the 'Owned Attribute' containment reference list
EList	getOwnedAttributes() Returns the value of the 'Owned Attribute' containment reference list.
Operation	getOwnedOperation(java.lang.String name) Retrieves the Operation with the specified 'Name' from the 'Owned Operation' containment reference list
EList	getOwnedOperations() Returns the value of the 'Owned Operation' containment reference list.
Reception	getOwnedReception(java.lang.String name) Retrieves the Reception with the specified 'Name' from the 'Owned Reception' containment reference list
EList	getOwnedReceptions() Returns the value of the 'Owned Reception' containment reference list.
ProtocolStateMachine	getProtocol() Returns the value of the 'Protocol' containment reference
Interface	getRedefinedInterface(java.lang.String name) Retrieves the Interface with the specified 'Name' from the 'Redefined Interface' reference list
EList	getRedefinedInterfaces() Returns the value of the 'Redefined Interface' reference list.
void	setProtocol(ProtocolStateMachine value) Sets the value of the 'Protocol' containment reference

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

getOwnedAttributes

public EList getOwnedAttributes()

Returns the value of the 'Owned Attribute' containment reference list. The list contents are of type Property.

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

References the properties owned by the Interface. (Subsets Namespace.ownedMember and Classifier.feature.)

Returns:

the value of the 'Owned Attribute' containment reference list.

See Also:

UML2Package.getInterface_OwnedAttribute()

getOwnedAttribute

public Property getOwnedAttribute(java.lang.String name)

Retrieves the Property with the specified 'Name' from the 'Owned Attribute' containment reference list.

Parameters:

name - The 'Name' of the Property to retrieve.

Returns:

The Property with the specified 'Name', or null.

See Also:

getOwnedAttributes()

createOwnedAttribute

public Property createOwnedAttribute(EClass eClass)

Creates a Property and appends it to the 'Owned Attribute' containment reference list.

Parameters:

eClass - The Ecore class of the Property to create.

Returns:

The new Property.

See Also:

getOwnedAttributes()

createOwnedAttribute

public Property createOwnedAttribute()

Creates a Property and appends it to the 'Owned Attribute' containment reference list.

Returns:

The new Property.

See Also:

getOwnedAttributes()

getOwnedOperations

public EList getOwnedOperations()

Returns the value of the 'Owned Operation' containment reference list. The list contents are of type Operation.

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

References the operations owned by the Interface. (Subsets Namespace.ownedMember and Classifier.feature.)

Returns:

the value of the 'Owned Operation' containment reference list.

See Also:

UML2Package.getInterface_OwnedOperation()

getOwnedOperation

public Operation getOwnedOperation(java.lang.String name)

Retrieves the Operation with the specified 'Name' from the 'Owned Operation' containment reference list.

Parameters:

name - The 'Name' of the Operation to retrieve.

Returns:

The Operation with the specified 'Name', or null.

See Also:

getOwnedOperations()

createOwnedOperation

public Operation createOwnedOperation(EClass eClass)

Deprecated. Use #createOwnedOperation() instead.

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

Parameters:

eClass - The Ecore class of the Operation to create.

Returns:

The new Operation.

See Also:

getOwnedOperations()

createOwnedOperation

public Operation createOwnedOperation()

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

Returns:

The new Operation.

See Also:

getOwnedOperations()

getRedefinedInterfaces

public EList getRedefinedInterfaces()

Returns the value of the 'Redefined Interface' reference list. The list contents are of type Interface.

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

(Subsets Element.redefinedElement.)

Returns:

the value of the 'Redefined Interface' reference list.

See Also:

UML2Package.getInterface_RedefinedInterface()

getRedefinedInterface

public Interface getRedefinedInterface(java.lang.String name)

Retrieves the Interface with the specified 'Name' from the 'Redefined Interface' reference list.

Parameters:

name - The 'Name' of the Interface to retrieve.

Returns:

The Interface with the specified 'Name', or null.

See Also:

getRedefinedInterfaces()

getNestedClassifiers

public EList getNestedClassifiers()

Returns the value of the 'Nested Classifier' containment reference list. The list contents are of type Classifier.

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

Returns:

the value of the 'Nested Classifier' containment reference list.

See Also:

UML2Package.getInterface_NestedClassifier()

getNestedClassifier

public Classifier getNestedClassifier(java.lang.String name)

Retrieves the Classifier with the specified 'Name' from the 'Nested Classifier' containment reference list.

Parameters:

name - The 'Name' of the Classifier to retrieve.

Returns:

The Classifier with the specified 'Name', or null.

See Also:

getNestedClassifiers()

createNestedClassifier

public Classifier createNestedClassifier(EClass eClass)

Creates a Classifier and appends it to the 'Nested Classifier' containment reference list.

Parameters:

eClass - The Ecore class of the Classifier to create.

Returns:

The new Classifier.

See Also:

getNestedClassifiers()

getOwnedReceptions

public EList getOwnedReceptions()

Returns the value of the 'Owned Reception' containment reference list. The list contents are of type Reception.

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

Receptions that objects providing this interface are willing to accept. (Subsets Namespace.ownedMember and Classifier.feature.)

Returns:

the value of the 'Owned Reception' containment reference list.

See Also:

UML2Package.getInterface_OwnedReception()

getOwnedReception

public Reception getOwnedReception(java.lang.String name)

Retrieves the Reception with the specified 'Name' from the 'Owned Reception' containment reference list.

Parameters:

name - The 'Name' of the Reception to retrieve.

Returns:

The Reception with the specified 'Name', or null.

See Also:

getOwnedReceptions()

createOwnedReception

public Reception createOwnedReception(EClass eClass)

Deprecated. Use #createOwnedReception() instead.

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

Parameters:

eClass - The Ecore class of the Reception to create.

Returns:

The new Reception.

See Also:

getOwnedReceptions()

createOwnedReception

public Reception createOwnedReception()

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

Returns:

The new Reception.

See Also:

getOwnedReceptions()

getProtocol

public ProtocolStateMachine getProtocol()

Returns the value of the 'Protocol' containment reference.

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

References a protocol state machine specifying the legal sequences of the invocation of the behavioral features described in the interface.

Returns:

the value of the 'Protocol' containment reference.

See Also:

setProtocol(ProtocolStateMachine), UML2Package.getInterface_Protocol()

setProtocol

public void setProtocol(ProtocolStateMachine value)

Sets the value of the 'Protocol' containment reference.

Parameters:

value - the new value of the 'Protocol' containment reference.

See Also:

getProtocol()

createProtocol

public ProtocolStateMachine createProtocol(EClass eClass)

Deprecated. Use #createProtocol() instead.

Creates a ProtocolStateMachine and sets the 'Protocol' containment reference.

Parameters:

eClass - The Ecore class of the ProtocolStateMachine to create.

Returns:

The new ProtocolStateMachine.

See Also:

getProtocol()

createProtocol

public ProtocolStateMachine createProtocol()

Creates a ProtocolStateMachine and sets the 'Protocol' containment reference.

Returns:

The new ProtocolStateMachine.

See Also:

getProtocol()

createOwnedAttribute

public Property createOwnedAttribute(java.lang.String name,
                                     Type type,
                                     int lowerBound,
                                     int upperBound)

Creates a property with the specified name, type, lower bound, and upper bound as an owned attribute of this interface.

Parameters:

name - The name for the owned attribute.

type - The type for the owned attribute.

lowerBound - The lower bound for the owned attribute.

upperBound - The upper bound for the owned attribute.

Returns:

The new property.

Throws:

java.lang.IllegalArgumentException - If either of the bounds is invalid.

createOwnedOperation

public Operation createOwnedOperation(java.lang.String name,
                                      Type returnType,
                                      java.lang.String[] parameterNames,
                                      Type[] parameterTypes)

Creates an operation with the specified name, return type, parameter names, and parameter types as an owned operation of this interface.

Parameters:

name - The name for the owned operation.

returnType - The return type for the owned operation, or null.

parameterNames - The names of the owned operation's parameters, or null.

parameterTypes - The types of the owned operation's parameters, or null.

Returns:

The new operation.

Throws:

java.lang.IllegalArgumentException - If the number of parameter names does not match the number of parameter types.