org.eclipse.ocl.examples.pivot
Interface TemplateParameter

All Superinterfaces:

Element, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, PivotObject, Visitable

All Known Subinterfaces:

OperationTemplateParameter, TypeTemplateParameter

All Known Implementing Classes:

OperationTemplateParameterImpl, TemplateParameterImpl, TypeTemplateParameterImpl

public interface TemplateParameter
extends Element

A representation of the model object 'Template Parameter'. A template parameter exposes a parameterable element as a formal template parameter of a template.

The following features are supported:

• Signature
• Parametered Element
• Owned Parametered Element
• Default
• Owned Default

See Also:

PivotPackage.getTemplateParameter()

Generated

Model

Method Summary

ParameterableElement	createOwnedDefault(org.eclipse.emf.ecore.EClass eClass) Creates a new ParameterableElement and sets the 'Owned Default' containment reference.
ParameterableElement	createOwnedParameteredElement(org.eclipse.emf.ecore.EClass eClass) Creates a new ParameterableElement and sets the 'Owned Parametered Element' containment reference.
ParameterableElement	getDefault() Returns the value of the 'Default' reference.
ParameterableElement	getOwnedDefault() Returns the value of the 'Owned Default' containment reference.
ParameterableElement	getOwnedParameteredElement() Returns the value of the 'Owned Parametered Element' containment reference.
ParameterableElement	getParameteredElement() Returns the value of the 'Parametered Element' reference.
TemplateSignature	getSignature() Returns the value of the 'Signature' container reference.
void	setDefault(ParameterableElement value) Sets the value of the 'Default' reference.
void	setOwnedDefault(ParameterableElement value) Sets the value of the 'Owned Default' containment reference.
void	setOwnedParameteredElement(ParameterableElement value) Sets the value of the 'Owned Parametered Element' containment reference.
void	setParameteredElement(ParameterableElement value) Sets the value of the 'Parametered Element' reference.
void	setSignature(TemplateSignature value) Sets the value of the 'Signature' container reference.
boolean	validateMustBeCompatible(org.eclipse.emf.common.util.DiagnosticChain diagnostics, java.util.Map<java.lang.Object,java.lang.Object> context) The default must be compatible with the formal template parameter.

Methods inherited from interface org.eclipse.ocl.examples.pivot.Element

createOwnedComment, getETarget, getOwnedComments

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.ocl.examples.pivot.util.Visitable

accept, eClass

Method Detail

getSignature

TemplateSignature getSignature()

Returns the value of the 'Signature' container reference. It is bidirectional and its opposite is 'Owned Parameter'. The template signature that owns this template parameter.

Returns:

the value of the 'Signature' container reference.

See Also:

setSignature(TemplateSignature), PivotPackage.getTemplateParameter_Signature(), TemplateSignature.getOwnedParameters()

Generated

Model

opposite="ownedParameter" required="true" transient="false" ordered="false"

setSignature

void setSignature(TemplateSignature value)

Sets the value of the 'Signature' container reference.

Parameters:

value - the new value of the 'Signature' container reference.

See Also:

getSignature()

Generated

getOwnedParameteredElement

ParameterableElement getOwnedParameteredElement()

Returns the value of the 'Owned Parametered Element' containment reference. It is bidirectional and its opposite is 'Owning Template Parameter'.

This feature subsets the following features:

• 'Parametered Element'

The element that is owned by this template parameter.

Returns:

the value of the 'Owned Parametered Element' containment reference.

See Also:

setOwnedParameteredElement(ParameterableElement), PivotPackage.getTemplateParameter_OwnedParameteredElement(), ParameterableElement.getOwningTemplateParameter()

Generated

Model

opposite="owningTemplateParameter" containment="true" ordered="false"

setOwnedParameteredElement

void setOwnedParameteredElement(ParameterableElement value)

Sets the value of the 'Owned Parametered Element' containment reference.

Parameters:

value - the new value of the 'Owned Parametered Element' containment reference.

See Also:

getOwnedParameteredElement()

Generated

createOwnedParameteredElement

ParameterableElement createOwnedParameteredElement(org.eclipse.emf.ecore.EClass eClass)

Creates a new ParameterableElement and sets the 'Owned Parametered Element' containment reference.

Parameters:

eClass - The Ecore class of the ParameterableElement to create.

Returns:

The new ParameterableElement.

See Also:

getOwnedParameteredElement()

Generated

getDefault

ParameterableElement getDefault()

Returns the value of the 'Default' reference. The element that is the default for this formal template parameter.

Returns:

the value of the 'Default' reference.

See Also:

setDefault(ParameterableElement), PivotPackage.getTemplateParameter_Default()

Generated

Model

ordered="false"

setDefault

void setDefault(ParameterableElement value)

Sets the value of the 'Default' reference.

Parameters:

value - the new value of the 'Default' reference.

See Also:

getDefault()

Generated

getOwnedDefault

ParameterableElement getOwnedDefault()

Returns the value of the 'Owned Default' containment reference.

This feature subsets the following features:

• 'Default'

The element that is owned by this template parameter for the purpose of providing a default.

Returns:

the value of the 'Owned Default' containment reference.

See Also:

setOwnedDefault(ParameterableElement), PivotPackage.getTemplateParameter_OwnedDefault()

Generated

Model

containment="true" ordered="false"

setOwnedDefault

void setOwnedDefault(ParameterableElement value)

Sets the value of the 'Owned Default' containment reference.

Parameters:

value - the new value of the 'Owned Default' containment reference.

See Also:

getOwnedDefault()

Generated

createOwnedDefault

ParameterableElement createOwnedDefault(org.eclipse.emf.ecore.EClass eClass)

Creates a new ParameterableElement and sets the 'Owned Default' containment reference.

Parameters:

eClass - The Ecore class of the ParameterableElement to create.

Returns:

The new ParameterableElement.

See Also:

getOwnedDefault()

Generated

getParameteredElement

ParameterableElement getParameteredElement()

Returns the value of the 'Parametered Element' reference. It is bidirectional and its opposite is 'Template Parameter'. The element exposed by this template parameter.

Returns:

the value of the 'Parametered Element' reference.

See Also:

setParameteredElement(ParameterableElement), PivotPackage.getTemplateParameter_ParameteredElement(), ParameterableElement.getTemplateParameter()

Generated

Model

opposite="templateParameter" required="true" ordered="false"

setParameteredElement

void setParameteredElement(ParameterableElement value)

Sets the value of the 'Parametered Element' reference.

Parameters:

value - the new value of the 'Parametered Element' reference.

See Also:

getParameteredElement()

Generated

validateMustBeCompatible

boolean validateMustBeCompatible(org.eclipse.emf.common.util.DiagnosticChain diagnostics,
                                 java.util.Map<java.lang.Object,java.lang.Object> context)

The default must be compatible with the formal template parameter. default->notEmpty() implies default->isCompatibleWith(parameteredElement)

Parameters:

diagnostics - The chain of diagnostics to which problems are to be appended.

context - The cache of context-specific information.

Generated

Model