org.mule.runtime.ast.api

Interface ComponentParameterAst

public interface ComponentParameterAst

Represents the user configuration of a parameter of a component.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Optional<ComponentMetadataAst>	getMetadata()
org.mule.runtime.api.meta.model.parameter.ParameterModel	getModel()
String	getRawValue()
<T> org.mule.runtime.api.functional.Either<String,T>	getValue() Returns either the expression for this parameter or a fixed value, depending on what is set in the DSL.

Method Detail

getModel

org.mule.runtime.api.meta.model.parameter.ParameterModel getModel()

Returns:

the model that represents this parameter.

getValue

<T> org.mule.runtime.api.functional.Either<String,T> getValue()

Returns either the expression for this parameter or a fixed value, depending on what is set in the DSL.

When using the right part returned by this method for a parameter that is a complex object defined inline, the definition of the object will be returned (a ComponentAst), not the object itself.

Returns:

the value of the parameter, or its default value if there is one defined and the parameter is not set.

getRawValue

String getRawValue()

Returns:

the value of the parameter as defined in the DSL.

getMetadata

Optional<ComponentMetadataAst> getMetadata()

Returns:

the parser metadata for this parameter if it is defined as a nested component, or Optional.empty() otherwise.