org.eclipse.uml2.uml
Interface TemplateParameterSubstitution

All Superinterfaces:
Element, EModelElement, EObject, Notifier

public interface TemplateParameterSubstitution
extends Element

A representation of the model object 'Template Parameter Substitution'. A template parameter substitution relates the actual parameter(s) to a formal template parameter as part of a template binding.

The following features are supported:

See Also:
UMLPackage.getTemplateParameterSubstitution()

Method Summary
 ParameterableElement createOwnedActual(EClass eClass)
          Creates a new ParameterableElement and appends it to the 'Owned Actual' containment reference list
 EList getActuals()
          Returns the value of the 'Actual' reference list.
 TemplateParameter getFormal()
          Returns the value of the 'Formal' reference
 EList getOwnedActuals()
          Returns the value of the 'Owned Actual' containment reference list.
 TemplateBinding getTemplateBinding()
          Returns the value of the 'Template Binding' container reference.
 void setFormal(TemplateParameter value)
          Sets the value of the 'Formal' reference
 void setTemplateBinding(TemplateBinding value)
          Sets the value of the 'Template Binding' container reference
 boolean validateMustBeCompatible(DiagnosticChain diagnostics, Map context)
           The actual parameter must be compatible with the formal template parameter, e.g. the actual parameter for a class template parameter must be a class.
 
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
 

Method Detail

getFormal

public TemplateParameter getFormal()
Returns the value of the 'Formal' reference. The formal template parameter that is associated with this substitution.

Returns:
the value of the 'Formal' reference.
See Also:
TemplateParameterSubstitution.setFormal(TemplateParameter), UMLPackage.getTemplateParameterSubstitution_Formal()

setFormal

public void setFormal(TemplateParameter value)
Sets the value of the 'Formal' reference.

Parameters:
value - the new value of the 'Formal' reference.
See Also:
TemplateParameterSubstitution.getFormal()

getActuals

public EList getActuals()
Returns the value of the 'Actual' reference list. The list contents are of type ParameterableElement. The elements that are the actual parameters for this substitution.

Returns:
the value of the 'Actual' reference list.
See Also:
UMLPackage.getTemplateParameterSubstitution_Actual()

getOwnedActuals

public EList getOwnedActuals()
Returns the value of the 'Owned Actual' containment reference list. The list contents are of type ParameterableElement. The actual parameters that are owned by this substitution.

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

createOwnedActual

public ParameterableElement createOwnedActual(EClass eClass)
Creates a new ParameterableElement and appends it to the 'Owned Actual' containment reference list.

Parameters:
eClass - The Ecore class of the ParameterableElement to create.
Returns:
The new ParameterableElement.
See Also:
TemplateParameterSubstitution.getOwnedActuals()

getTemplateBinding

public TemplateBinding getTemplateBinding()
Returns the value of the 'Template Binding' container reference. It is bidirectional and its opposite is 'Parameter Substitution'. The optional bindings from this element to templates.

Returns:
the value of the 'Template Binding' container reference.
See Also:
TemplateParameterSubstitution.setTemplateBinding(TemplateBinding), UMLPackage.getTemplateParameterSubstitution_TemplateBinding(), TemplateBinding.getParameterSubstitutions()

setTemplateBinding

public void setTemplateBinding(TemplateBinding value)
Sets the value of the 'Template Binding' container reference.

Parameters:
value - the new value of the 'Template Binding' container reference.
See Also:
TemplateParameterSubstitution.getTemplateBinding()

validateMustBeCompatible

public boolean validateMustBeCompatible(DiagnosticChain diagnostics,
                                        Map context)
The actual parameter must be compatible with the formal template parameter, e.g. the actual parameter for a class template parameter must be a class. actual->forAll(a | a.isCompatibleWith(formal.parameteredElement))


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