org.mule.runtime.api.app.declaration

Interface CustomizableElementDeclaration

All Known Subinterfaces:

GlobalElementDeclaration

All Known Implementing Classes:

ArtifactDeclaration, ComponentElementDeclaration, ConfigurationElementDeclaration, ConnectionElementDeclaration, ConstructElementDeclaration, EnrichableElementDeclaration, OperationElementDeclaration, ParameterGroupElementDeclaration, ParameterizedElementDeclaration, RouteElementDeclaration, SourceElementDeclaration, TopLevelParameterDeclaration

public interface CustomizableElementDeclaration

A declaration which can be augmented with custom pieces of information that are not part of the actual element model.

This is useful for pieces of data that might be specific to particular representations of the declared artifact, like custom XML properties or conventions that are not related to the artifact model but necessary for not loosing information during its serialization/deserialization.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	addCustomConfigurationParameter(ParameterElementDeclaration customParameter) Adds a custom parameter to this enrichable element declaration.
List<ParameterElementDeclaration>	getCustomConfigurationParameters() The customConfigurationParameters refer to parameters that are part of a declaration configuration but do not match to an element in the model, thus being custom of how the declaration was created.

Method Detail

getCustomConfigurationParameters

List<ParameterElementDeclaration> getCustomConfigurationParameters()

The customConfigurationParameters refer to parameters that are part of a declaration configuration but do not match to an element in the model, thus being custom of how the declaration was created. An example for this would be having a <ns:identifier doc:name="myCustomName">, where doc:name is a custom attribute that enriches the XML representation of an ElementDeclaration

Returns:

the List of parameters associated with this

addCustomConfigurationParameter

void addCustomConfigurationParameter(ParameterElementDeclaration customParameter)

Adds a custom parameter to this enrichable element declaration. The customConfigurationParameters refer to parameters that are part of a declaration configuration but do not match to an element in the model, thus being custom of how the declaration was created. An example for this would be having a <ns:identifier doc:name="myCustomName">, where doc:name is a custom attribute that enriches the XML representation of an ElementDeclaration No validation of any kind will be performed over this customParameter and its value.

Parameters:

customParameter - the ParameterElementDeclaration to associate to this element declaration