org.mule.runtime.api.app.declaration

Class EnrichableElementDeclaration

java.lang.Object

org.mule.runtime.api.app.declaration.ElementDeclaration

org.mule.runtime.api.app.declaration.EnrichableElementDeclaration

All Implemented Interfaces:

CustomizableElementDeclaration, IdentifiableElementDeclaration, MetadataPropertiesAwareElementDeclaration, NamedElementDeclaration

Direct Known Subclasses:

ArtifactDeclaration, ParameterGroupElementDeclaration, ParameterizedElementDeclaration, TopLevelParameterDeclaration

public abstract class EnrichableElementDeclaration
extends ElementDeclaration
implements CustomizableElementDeclaration, MetadataPropertiesAwareElementDeclaration

A programmatic descriptor of an ElementDeclaration that can be enriched with custom properties and parameters.

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.app.declaration.ElementDeclaration

declaringExtension, name

Constructor Summary

Constructors

Constructor and Description
EnrichableElementDeclaration()

Method Summary

Modifier and Type	Method and Description
void	addCustomConfigurationParameter(ParameterElementDeclaration customParameter) Adds a custom parameter to this enrichable element declaration.
void	addMetadataProperty(String name, Serializable value) Adds a metadataProperty to the ElementDeclaration.
boolean	equals(Object o)
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.
Map<String,Serializable>	getMetadataProperties()
Optional<Serializable>	getMetadataProperty(String name) Retrieves a metadataProperty to the ElementDeclaration.
int	hashCode()

Methods inherited from class org.mule.runtime.api.app.declaration.ElementDeclaration

getDeclaringExtension, getName, setDeclaringExtension, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EnrichableElementDeclaration

public EnrichableElementDeclaration()

Method Detail

getCustomConfigurationParameters

public 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

Specified by:

getCustomConfigurationParameters in interface CustomizableElementDeclaration

Returns:

the List of parameters associated with this

addCustomConfigurationParameter

public 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.

Specified by:

addCustomConfigurationParameter in interface CustomizableElementDeclaration

Parameters:

customParameter - the ParameterElementDeclaration to associate to this element declaration

getMetadataProperty

public Optional<Serializable> getMetadataProperty(String name)

Retrieves a metadataProperty to the ElementDeclaration. This property is meant to hold only metadata of the declaration, related to how the declaration has to be represented but not affecting nor containing information related to the model configured with this declaration.

Specified by:

getMetadataProperty in interface MetadataPropertiesAwareElementDeclaration

Parameters:

name - the name of the property

Returns:

the property for the given name, or Optional.empty() if none was found.

getMetadataProperties

public Map<String,Serializable> getMetadataProperties()

Specified by:

getMetadataProperties in interface MetadataPropertiesAwareElementDeclaration

Returns:

the metadata properties associated to this EnrichableElementDeclaration

addMetadataProperty

public void addMetadataProperty(String name,
                                Serializable value)

Adds a metadataProperty to the ElementDeclaration. This property is meant to hold only metadata of the declaration, related to how the declaration has to be represented but not affecting nor containing information related to the model configured with this declaration. This property may contain information regarding things like transformations required for the persistence of a given element, or propagating particular metadata of how the declaration was originally declared before deserialization. An example for this would be having an xmlns prefix declared different than the one declared by the extension. So in order to represent: <my-http-alias:listener-config> we will declare an http:listener-config adding also a metadataProperty with the custom prefix my-http-alias. This way, we can honour the original XML representation, but keep the ElementDeclaration closer the the model it represents.

Specified by:

addMetadataProperty in interface MetadataPropertiesAwareElementDeclaration

Parameters:

name - custom attribute name.

value - custom attribute value.

equals

public boolean equals(Object o)

Overrides:

equals in class ElementDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class ElementDeclaration