org.mule.runtime.config.api.dsl.model

Class DslElementModel<T>

java.lang.Object

org.mule.runtime.config.api.dsl.model.DslElementModel<T>

public final class DslElementModel<T>
extends Object

Provides a declaration of how a given model of type T is related to its DSL representation.

This DslElementModel can be related to an ComponentConfiguration of a configuration file by using the findElement(org.mule.runtime.api.component.ComponentIdentifier) lookup with the required ComponentIdentifier, and thus providing a way to relate an ComponentConfiguration to the ExtensionModel component or MetadataType it represents.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DslElementModel.Builder<M>

Method Summary

Modifier and Type	Method and Description
static <M> DslElementModel.Builder<M>	builder()
boolean	equals(Object o)
<E> Optional<DslElementModel<E>>	findElement(ComponentIdentifier identifier) Lookup method for finding a given DslElementModel based on its identifier from this element as root.
<E> Optional<DslElementModel<E>>	findElement(String modelName) Lookup method for finding a given DslElementModel based on its parameterName from this element as root.
Optional<ComponentConfiguration>	getConfiguration()
List<DslElementModel>	getContainedElements()
DslElementSyntax	getDsl()
Optional<ComponentIdentifier>	getIdentifier()
T	getModel()
Optional<String>	getValue()
int	hashCode()
boolean	isExplicitInDsl()

Methods inherited from class java.lang.Object

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

Method Detail

getModel

public T getModel()

Returns:

the model associated to this element

getDsl

public DslElementSyntax getDsl()

Returns:

the DslElementSyntax associated to this element

getContainedElements

public List<DslElementModel> getContainedElements()

Returns:

a List with all the child elements

getIdentifier

public Optional<ComponentIdentifier> getIdentifier()

Returns:

the identifier associated to this element, if one was provided.

getConfiguration

public Optional<ComponentConfiguration> getConfiguration()

Returns:

the ComponentConfiguration associated to this element, if one was provided.

getValue

public Optional<String> getValue()

Returns:

the value assigned to this element in its current configuration. This represents either the value of an attribute or that of a text child element.

isExplicitInDsl

public boolean isExplicitInDsl()

Returns:

true if the element represented by this DslElementModel has to be explicitly declared in the DSL, or if it's only present in the internal application representation.

findElement

public <E> Optional<DslElementModel<E>> findElement(ComponentIdentifier identifier)

Lookup method for finding a given DslElementModel based on its identifier from this element as root. If this DslElementModel doesn't match with the given identifier, then a DFS lookup is performed for each of its inner elements.

Parameters:

identifier - the ComponentIdentifier used for matching

Returns:

the DslElementModel associated to the given identifier, if one was found.

findElement

public <E> Optional<DslElementModel<E>> findElement(String modelName)

Lookup method for finding a given DslElementModel based on its parameterName from this element as root. If this DslElementModel name doesn't match with the given parameterName, then a DFS lookup is performed for each of its inner elements. Since not all the elements may in an application may have an DslElementSyntax::getElementName this lookup method may produce different results than the lookup by identifier

Parameters:

modelName - the modelName used for matching

Returns:

the DslElementModel associated to the given identifier, if one was found.

builder

public static <M> DslElementModel.Builder<M> builder()

Returns:

a new DslElementModel.Builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object