org.mule.runtime.ast.api

Interface ComponentAst

public interface ComponentAst

Represents the user configuration of a component (flow, config, message processor, etc) defined in an artifact configuration file.

Every ComponentAst represents the configuration of a core configuration or an extension configuration. Which configuration element this object represents is identified by a ComponentIdentifier that can be retrieved using #getName().

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	BODY_RAW_PARAM_NAME Deprecated. this will be removed for 1.0.0.

Method Summary

Modifier and Type	Method and Description
Spliterator<ComponentAst>	directChildrenSpliterator()
Stream<ComponentAst>	directChildrenStream()
Optional<String>	getComponentId()
org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType	getComponentType()
org.mule.runtime.api.component.ComponentIdentifier	getIdentifier()
org.mule.runtime.api.component.location.ComponentLocation	getLocation()
ComponentMetadataAst	getMetadata()
<M> Optional<M>	getModel(Class<M> modelClass) A component may be represented by different kinds of models, depending on the actual type of this component.
ComponentParameterAst	getParameter(String paramName)
Collection<ComponentParameterAst>	getParameters() A parameter may have a value either because it is explicitly set in the DSL, or because the extension model defines a default value for it.
Optional<String>	getRawParameterValue(String paramName) Deprecated. Use getParameter(String) instead. This will removed before 1.0.0.
Spliterator<ComponentAst>	recursiveSpliterator()
Stream<ComponentAst>	recursiveStream()

Field Detail

BODY_RAW_PARAM_NAME

@Deprecated
static final String BODY_RAW_PARAM_NAME

Deprecated. this will be removed for 1.0.0.

See Also:

Constant Field Values

Method Detail

getIdentifier

org.mule.runtime.api.component.ComponentIdentifier getIdentifier()

Returns:

the identifier for the configuration element this object represents.

getComponentType

org.mule.runtime.api.component.TypedComponentIdentifier.ComponentType getComponentType()

Returns:

a general typification of the role of this component.

getLocation

org.mule.runtime.api.component.location.ComponentLocation getLocation()

Returns:

the location of the component in the configuration.

getMetadata

ComponentMetadataAst getMetadata()

Returns:

the parser metadata for this component.

getComponentId

Optional<String> getComponentId()

Returns:

the id of this component if it has one defined, or empty otherwise.

getModel

<M> Optional<M> getModel(Class<M> modelClass)

A component may be represented by different kinds of models, depending on the actual type of this component. Possible values may be, for instance, instances of ConfigurationModel, ComponentModel or ConnectionProviderModel (but not necessarily limited to those).

Parameters:

modelClass - the class of the model this method should return.

Returns:

the model that represents this component.

getRawParameterValue

@Deprecated
Optional<String> getRawParameterValue(String paramName)

Deprecated. Use getParameter(String) instead. This will removed before 1.0.0.

Parameters:

paramName - the name of the parameter to get the raw value for.

Returns:

the value of the parameter as defined in the DSL if present, or Optional.empty() if not present.

getParameter

ComponentParameterAst getParameter(String paramName)

Parameters:

paramName - the name of the parameter to get AST for.

Returns:

the AST of the parameter.

Throws:

NoSuchElementException - if there is no parameter with the given paramName.

getParameters

Collection<ComponentParameterAst> getParameters()

A parameter may have a value either because it is explicitly set in the DSL, or because the extension model defines a default value for it.

Returns:

the ASTs of all the parameters that have a value.

recursiveStream

Stream<ComponentAst> recursiveStream()

Returns:

a Stream for this component and its children recursively that navigates the whole AST.

recursiveSpliterator

Spliterator<ComponentAst> recursiveSpliterator()

Returns:

a Spliterator for this component and its children recursively that navigates the whole AST.

directChildrenStream

Stream<ComponentAst> directChildrenStream()

Returns:

a Stream for this component and its children recursively that navigates the whole AST.

directChildrenSpliterator

Spliterator<ComponentAst> directChildrenSpliterator()

Returns:

a Spliterator for this component and its children recursively that navigates the whole AST.