org.andromda.metafacades.uml

Interface TemplateParameterFacade

public interface TemplateParameterFacade

Represents a UML template parameter. Exposes a parameterable element as a formal template parameter of a template. Only UML2 TemplateParameter inherits from ModelElement, so the UML14 implementation cannot extend ModelElement. UML14 TemplateParameter.parameter inherits from Parameter. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ClassifierFacade>	getConstrainingClassifiers() UML2 only: Returns the list of classifiers (Classes) which constrain the parameter type.
ModelElementFacade	getDefaultElement() Return the default element for the template parameter
String	getDocumentation(String indent) Gets the documentation for the model element, The indent argument is prefixed to each line.
String	getDocumentation(String indent, int lineLength) This method returns the documentation for this model element, with the lines wrapped after the specified number of characters, values of less than 1 will indicate no line wrapping is required.
String	getDocumentation(String indent, int lineLength, boolean htmlStyle) TODO: Model Documentation for org.andromda.metafacades.uml.TemplateParameterFacade.getDocumentation
String	getFullyQualifiedName() Return the fully qualified name of the template parameter: package + class + parameter name
String	getGetterName() get + capitalized parameter name
String	getGetterSetterTypeName() The type of the template parameter.
String	getName() TODO: Model Documentation for org.andromda.metafacades.uml.TemplateParameterFacade.name
ModelElementFacade	getOwner() The ModelElement that owns this parameter.
ModelElementFacade	getParameter() Returns the parameter value for the template parameter.
String	getSetterName() set + capitalized parameter name
ClassifierFacade	getType() TemplateParameter may be of type Classifier, PackageableElement, Operation or Property.
String	getValidationName() Gets the name of the metafacade used within validation messages.
Object	getValidationOwner() Gets the metafacade that acts as the owner of this metafacade.
void	initialize() Provides any required initialization of the metafacade.
boolean	isTemplateParameterFacadeMetaType() Indicates the metafacade type (used for metafacade mappings).
void	validateInvariants(Collection<ModelValidationMessage> validationMessages) Performs validation of any invariants found on this model element and stores the messages within the validationMessages collection.

Method Detail

isTemplateParameterFacadeMetaType

boolean isTemplateParameterFacadeMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

initialize

void initialize()

Provides any required initialization of the metafacade.

getValidationOwner

Object getValidationOwner()

Gets the metafacade that acts as the owner of this metafacade. (for example: an operation is an owner of its parameters, etc). This is used by AndroMDA's validation framework to provide more context as to where the error has occurred.

Returns:

Object the Validation Owner

getValidationName

String getValidationName()

Gets the name of the metafacade used within validation messages. This provides the full name of the metafacade.

Returns:

String the Validation Name

validateInvariants

void validateInvariants(Collection<ModelValidationMessage> validationMessages)

Performs validation of any invariants found on this model element and stores the messages within the validationMessages collection.

Parameters:

validationMessages - the collection of messages to which additional validation messages will be added if invariants are broken.

getConstrainingClassifiers

Collection<ClassifierFacade> getConstrainingClassifiers()

UML2 only: Returns the list of classifiers (Classes) which constrain the parameter type. Results in declaration.

Returns:

Collection

getDefaultElement

ModelElementFacade getDefaultElement()

Return the default element for the template parameter

Returns:

ModelElementFacade

getDocumentation

String getDocumentation(String indent)

Gets the documentation for the model element, The indent argument is prefixed to each line. By default this method wraps lines after 64 characters. This method is equivalent to getDocumentation(indent, 64).

Parameters:

indent - String

Returns:

String

getDocumentation

String getDocumentation(String indent,
                      int lineLength)

This method returns the documentation for this model element, with the lines wrapped after the specified number of characters, values of less than 1 will indicate no line wrapping is required. By default paragraphs are returned as HTML. This method is equivalent to getDocumentation(indent, lineLength, true).

Parameters:

indent - String

lineLength - int

Returns:

String

getDocumentation

String getDocumentation(String indent,
                      int lineLength,
                      boolean htmlStyle)

TODO: Model Documentation for org.andromda.metafacades.uml.TemplateParameterFacade.getDocumentation

Parameters:

indent - String

lineLength - int

htmlStyle - boolean

Returns:

String

getFullyQualifiedName

String getFullyQualifiedName()

Return the fully qualified name of the template parameter: package + class + parameter name

Returns:

String

getGetterName

String getGetterName()

get + capitalized parameter name

Returns:

String

getGetterSetterTypeName

String getGetterSetterTypeName()

The type of the template parameter.

Returns:

String

getName

String getName()

TODO: Model Documentation for org.andromda.metafacades.uml.TemplateParameterFacade.name

Returns:

String

getOwner

ModelElementFacade getOwner()

The ModelElement that owns this parameter. For UML14, the classifier package. For UML2, the Classifier.

Returns:

ModelElementFacade

getParameter

ModelElementFacade getParameter()

Returns the parameter value for the template parameter. In andromda, parameter and template parameter functionality are combined for simplicity.

Returns:

ModelElementFacade

getSetterName

String getSetterName()

set + capitalized parameter name

Returns:

String

getType

ClassifierFacade getType()

TemplateParameter may be of type Classifier, PackageableElement, Operation or Property. Generally a Class parameter has a name and a type of Classifier.

Returns:

ClassifierFacade