org.mule.tooling.client.api.artifact.ast

Class ComponentParameterAst

java.lang.Object

org.mule.tooling.client.api.artifact.ast.ComponentParameterAst

public class ComponentParameterAst
extends Object

Represents the user configuration of a parameter of a component.

Since:

1.4

Constructor Summary

Constructors

Constructor and Description
ComponentParameterAst(ParameterModel paramModel, Optional<String> expressionValue, Optional<Object> fixedValue, String rawValue, String resolvedRawValue, SourceCodeLocation metadata, ComponentGenerationInformation generationInformation, boolean defaultValue)

Method Summary

Modifier and Type	Method and Description
Optional<String>	getExpressionValue() Returns the expression for this parameter if it is an expression, or Optional.empty() otherwise.
Optional<Object>	getFixedValue() Returns the fixed value for this parameter if it is not expression, or Optional.empty() otherwise.
ComponentGenerationInformation	getGenerationInformation()
Optional<SourceCodeLocation>	getMetadata()
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.
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 Detail

ComponentParameterAst

public ComponentParameterAst(ParameterModel paramModel,
                             Optional<String> expressionValue,
                             Optional<Object> fixedValue,
                             String rawValue,
                             String resolvedRawValue,
                             SourceCodeLocation metadata,
                             ComponentGenerationInformation generationInformation,
                             boolean defaultValue)

Method Detail

getModel

public ParameterModel getModel()

Returns:

the model that represents this parameter.

getExpressionValue

public Optional<String> getExpressionValue()

Returns the expression for this parameter if it is an expression, or Optional.empty() otherwise.

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 in the DSL.

getFixedValue

public Optional<Object> getFixedValue()

Returns the fixed value for this parameter if it is not expression, or Optional.empty() otherwise.

When the value 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 in the DSL.

getRawValue

public String getRawValue()

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

Returns:

the value of the parameter as defined in the DSL.

getResolvedRawValue

public String getResolvedRawValue()

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

Returns:

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

getMetadata

public Optional<SourceCodeLocation> getMetadata()

Returns:

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

getGenerationInformation

public ComponentGenerationInformation getGenerationInformation()

Returns:

an object containing information about the generation of this parameter.

isDefaultValue

public boolean isDefaultValue()

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

Returns:

true if and only if this is a default parameter