org.mule.runtime.api.app.declaration

Class ParameterElementDeclaration

java.lang.Object

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

org.mule.runtime.api.app.declaration.ParameterElementDeclaration

All Implemented Interfaces:

IdentifiableElementDeclaration, MetadataPropertiesAwareElementDeclaration, NamedElementDeclaration

public final class ParameterElementDeclaration
extends ElementDeclaration
implements MetadataPropertiesAwareElementDeclaration

A programmatic descriptor of a ParameterModel configuration.

Since:

1.0

Field Summary

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

declaringExtension, name

Constructor Summary

Constructors

Constructor and Description
ParameterElementDeclaration()
ParameterElementDeclaration(String name)

Method Summary

Modifier and Type	Method and Description
void	addMetadataProperty(String name, Serializable value) Adds a metadataProperty to the ElementDeclaration.
boolean	equals(Object o)
Map<String,Serializable>	getMetadataProperties()
Optional<Serializable>	getMetadataProperty(String name) Retrieves a metadataProperty to the ElementDeclaration.
ParameterValue	getValue()
int	hashCode()
void	setValue(ParameterValue value) Associates a ParameterValue as part of this parameter configuration declaration

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

ParameterElementDeclaration

public ParameterElementDeclaration()

ParameterElementDeclaration

public ParameterElementDeclaration(String name)

Method Detail

setValue

public void setValue(ParameterValue value)

Associates a ParameterValue as part of this parameter configuration declaration

Parameters:

value - the ParameterValue to associate with this parameter configuration

getValue

public ParameterValue getValue()

Returns:

the ParameterValue configured for this parameter declaration

equals

public boolean equals(Object o)

Overrides:

equals in class ElementDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class ElementDeclaration

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.