org.mule.runtime.app.declaration.api

Class ConfigurationElementDeclaration

java.lang.Object

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

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

org.mule.runtime.app.declaration.api.ParameterizedElementDeclaration

org.mule.runtime.app.declaration.api.ConfigurationElementDeclaration

All Implemented Interfaces:

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

public final class ConfigurationElementDeclaration
extends ParameterizedElementDeclaration
implements GlobalElementDeclaration

A programmatic descriptor of a org.mule.runtime.api.meta.model.config.ConfigurationModel configuration.

Since:

1.0

Field Summary

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

declaringExtension, name

Constructor Summary

Constructors

Constructor and Description
ConfigurationElementDeclaration()
ConfigurationElementDeclaration(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.
void	accept(ParameterizedElementDeclarationVisitor visitor)
boolean	equals(Object o)
<T extends ElementDeclaration> Optional<T>	findElement(List<String> parts) Looks for a ParameterElementDeclaration contained by this declaration based on the parts of a Location.
Optional<ConnectionElementDeclaration>	getConnection()
String	getRefName()
int	hashCode()
void	setConnection(ConnectionElementDeclaration connection)
void	setRefName(String referableName) Sets the configured name of the element that can be used to reference it in the context of an ArtifactDeclaration

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

addParameterGroup, getParameterGroup, getParameterGroups

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

addCustomConfigurationParameter, addMetadataProperty, getCustomConfigurationParameters, getMetadataProperties, getMetadataProperty

Methods inherited from class org.mule.runtime.app.declaration.api.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.app.declaration.api.CustomizableElementDeclaration

addCustomConfigurationParameter, getCustomConfigurationParameters

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

getDeclaringExtension, setDeclaringExtension

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

getName, setName

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

addMetadataProperty, getMetadataProperties, getMetadataProperty

Constructor Detail

ConfigurationElementDeclaration

public ConfigurationElementDeclaration()

ConfigurationElementDeclaration

public ConfigurationElementDeclaration(String extension,
                                       String name)

Method Detail

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

getConnection

public Optional<ConnectionElementDeclaration> getConnection()

Returns:

the ConnectionElementDeclaration of this configurat

setConnection

public void setConnection(ConnectionElementDeclaration connection)

findElement

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

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

Specified by:

findElement in interface ElementDeclarationContainer

Overrides:

findElement in class ParameterizedElementDeclaration

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.

accept

public void accept(ParameterizedElementDeclarationVisitor visitor)

Specified by:

accept in class ParameterizedElementDeclaration

equals

public boolean equals(Object o)

Overrides:

equals in class ParameterizedElementDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class ParameterizedElementDeclaration

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