Module org.mule.runtime.artifact.ast

Package org.mule.runtime.ast.api.util

Class BaseComponentParameterAstDecorator

java.lang.Object

org.mule.runtime.ast.api.util.BaseComponentParameterAstDecorator

All Implemented Interfaces:

ComponentParameterAst

public class BaseComponentParameterAstDecorator
extends Object
implements ComponentParameterAst

This class provides a skeletal implementation of the ComponentParameterAst interface, to minimize the effort required to implement this interface when decorating instances of ComponentParameterAst.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
BaseComponentParameterAstDecorator(ComponentParameterAst decorated)	Creates a new decorator for the provided instance.

Method Summary

Modifier and Type	Method	Description
protected ComponentParameterAst	getDecorated()
ComponentGenerationInformation	getGenerationInformation()
org.mule.runtime.api.meta.model.parameter.ParameterGroupModel	getGroupModel()
Optional<ComponentMetadataAst>	getMetadata()
org.mule.runtime.api.meta.model.parameter.ParameterModel	getModel()
String	getRawValue()	This method WILL NOT resolve any property placeholders to the actual values if present.
String	getResolvedRawValue()	This method WILL resolve any property placeholders to the actual values if present.
<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.
<T> org.mule.runtime.api.functional.Either<String,org.mule.runtime.api.functional.Either<ParameterResolutionException,T>>	getValueOrResolutionError()	Returns either the expression for this parameter, a ParameterResolutionException occurred while converting the value to its expected type, a fixed value, depending on what is set in the DSL.
boolean	isDefaultValue()	Returns true if this is a default parameter; returns false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Details

BaseComponentParameterAstDecorator

public BaseComponentParameterAstDecorator(ComponentParameterAst decorated)

Creates a new decorator for the provided instance.

Parameters:

decorated - the ComponentParameterAst instance to decorate.

Method Details

getDecorated

protected ComponentParameterAst getDecorated()

Returns:

the decorated ComponentParameterAst instance.

getModel

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

Specified by:

getModel in interface ComponentParameterAst

Returns:

the model that represents this parameter.

getGroupModel

public org.mule.runtime.api.meta.model.parameter.ParameterGroupModel getGroupModel()

Specified by:

getGroupModel in interface ComponentParameterAst

Returns:

the group model that contains the represented parameter or null.

getValue

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

Description copied from interface: ComponentParameterAst

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.

Specified by:

getValue in interface ComponentParameterAst

Returns:

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

getValueOrResolutionError

public <T>
org.mule.runtime.api.functional.Either<String,org.mule.runtime.api.functional.Either<ParameterResolutionException,T>> getValueOrResolutionError()

Description copied from interface: ComponentParameterAst

Returns either the expression for this parameter, a ParameterResolutionException occurred while converting the value to its expected type, a fixed value, depending on what is set in the DSL.

Refer to ComponentParameterAst.getValue() for details on the left and the right,right returned value.

Specified by:

getValueOrResolutionError in interface ComponentParameterAst

Returns:

the value of the parameter, or a ParameterResolutionException if an error occurred converting a fixed value to the type of the parameter declaration.

getRawValue

public String getRawValue()

Description copied from interface: ComponentParameterAst

This method WILL NOT resolve any property placeholders to the actual values if present. Use ComponentParameterAst.getResolvedRawValue() or ComponentParameterAst.getValue() if properties resolution is needed.

Specified by:

getRawValue in interface ComponentParameterAst

Returns:

the value of the parameter as defined in the DSL.

getResolvedRawValue

public String getResolvedRawValue()

Description copied from interface: ComponentParameterAst

This method WILL resolve any property placeholders to the actual values if present. Use ComponentParameterAst.getRawValue() if properties resolution is not wanted.

Property placeholders resolution is done with the object given to ArtifactAst.updatePropertiesResolver(java.util.function.UnaryOperator).

Specified by:

getResolvedRawValue in interface ComponentParameterAst

Returns:

the value of the parameter as defined in the DSL and its property placeholders resolved.

getMetadata

public Optional<ComponentMetadataAst> getMetadata()

Specified by:

getMetadata in interface ComponentParameterAst

Returns:

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

getGenerationInformation

public ComponentGenerationInformation getGenerationInformation()

Specified by:

getGenerationInformation in interface ComponentParameterAst

Returns:

an object containing information about the generation of this parameter.

isDefaultValue

public boolean isDefaultValue()

Description copied from interface: ComponentParameterAst

Returns true if this is a default parameter; returns false otherwise.

Specified by:

isDefaultValue in interface ComponentParameterAst

Returns:

true if and only if this is a default parameter