org.mule.runtime.api.app.declaration

Class TopLevelParameterDeclaration

java.lang.Object

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

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

org.mule.runtime.api.app.declaration.TopLevelParameterDeclaration

All Implemented Interfaces:

CustomizableElementDeclaration, ElementDeclarationContainer, GlobalElementDeclaration, IdentifiableElementDeclaration, MetadataPropertiesAwareElementDeclaration, NamedElementDeclaration, ReferableElementDeclaration

public final class TopLevelParameterDeclaration
extends EnrichableElementDeclaration
implements ReferableElementDeclaration, GlobalElementDeclaration

A programmatic descriptor of an ObjectType configuration that will be used as a global element of the mule application.

Since:

1.0

Field Summary

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

declaringExtension, name

Constructor Summary

Constructors

Constructor and Description
TopLevelParameterDeclaration()
TopLevelParameterDeclaration(String extension, String name)

Method Summary

Modifier and Type	Method and Description
void	accept(GlobalElementDeclarationVisitor visitor) Dispatches to the method with prefix "visit" with the specific value type as argument.
boolean	equals(Object o)
<T extends ElementDeclaration> Optional<T>	findElement(List<String> parts) Looks for an ElementDeclaration contained by this declaration based on the parts of a Location.
String	getRefName()
ParameterObjectValue	getValue()
int	hashCode()
void	setRefName(String referableName) Sets the configured name of the element that can be used to reference it in the context of an ArtifactDeclaration
void	setValue(ParameterObjectValue value) Associates a ParameterObjectValue as part of this parameter configuration declaration

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

addCustomConfigurationParameter, addMetadataProperty, getCustomConfigurationParameters, getMetadataProperties, getMetadataProperty

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

Methods inherited from interface org.mule.runtime.api.app.declaration.CustomizableElementDeclaration

addCustomConfigurationParameter, getCustomConfigurationParameters

Methods inherited from interface org.mule.runtime.api.app.declaration.IdentifiableElementDeclaration

getDeclaringExtension, setDeclaringExtension

Methods inherited from interface org.mule.runtime.api.app.declaration.NamedElementDeclaration

getName, setName

Methods inherited from interface org.mule.runtime.api.app.declaration.MetadataPropertiesAwareElementDeclaration

addMetadataProperty, getMetadataProperties, getMetadataProperty

Constructor Detail

TopLevelParameterDeclaration

public TopLevelParameterDeclaration()

TopLevelParameterDeclaration

public TopLevelParameterDeclaration(String extension,
                                    String name)

Method Detail

setValue

public void setValue(ParameterObjectValue value)

Associates a ParameterObjectValue as part of this parameter configuration declaration

Since a TopLevelParameterDeclaration represents an ObjectType global declaration, only a ParameterObjectValue can be associated to it.

Parameters:

value - the ParameterObjectValue to associate with this parameter configuration

getValue

public ParameterObjectValue getValue()

Returns:

the ParameterObjectValue configured for this parameter declaration

getRefName

public String getRefName()

Specified by:

getRefName in interface ReferableElementDeclaration

Returns:

the configured name of the element that can be used to reference it in the context of an ArtifactDeclaration

setRefName

public void setRefName(String referableName)

Sets the configured name of the element that can be used to reference it in the context of an ArtifactDeclaration

Specified by:

setRefName in interface ReferableElementDeclaration

Parameters:

referableName - the configured name of the element

equals

public boolean equals(Object o)

Overrides:

equals in class EnrichableElementDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class EnrichableElementDeclaration

accept

public void accept(GlobalElementDeclarationVisitor visitor)

Description copied from interface: GlobalElementDeclaration

Dispatches to the method with prefix "visit" with the specific value type as argument. Example visitObjectValue(ParameterObjectValue objectValue) will be called when this value is an GlobalElementDeclaration.

Specified by:

accept in interface GlobalElementDeclaration

Parameters:

visitor - the visitor

findElement

public <T extends ElementDeclaration> Optional<T> findElement(List<String> parts)

Description copied from interface: ElementDeclarationContainer

Looks for an ElementDeclaration contained by this declaration based on the parts of a Location.

Specified by:

findElement in interface ElementDeclarationContainer

Parameters:

parts - the parts of a Location relative to this element

Returns:

the ElementDeclaration located in the path created by the parts or Optional.empty() if no ElementDeclaration was found in that location.