org.mule.runtime.api.meta.model.declaration.fluent

Class ParameterDeclaration

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.NamedDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.AbstractParameterDeclaration<ParameterDeclaration>

org.mule.runtime.api.meta.model.declaration.fluent.ParameterDeclaration

All Implemented Interfaces:

DescribedObject, TypedDeclaration, WithDeprecatedDeclaration, WithSemanticTermsDeclaration, NamedObject

public class ParameterDeclaration
extends AbstractParameterDeclaration<ParameterDeclaration>
implements TypedDeclaration, WithDeprecatedDeclaration, WithSemanticTermsDeclaration

A declaration object for a ParameterModel. It contains raw, unvalidated data which is used to declare the structure of a ParameterModel.

By default, getExpressionSupport() ()} returns ExpressionSupport.SUPPORTED.

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.model.declaration.fluent.AbstractParameterDeclaration

layoutModel

Constructor Summary

Constructors

Constructor and Description
ParameterDeclaration(String name)

Method Summary

Modifier and Type	Method and Description
void	addSemanticTerm(String semanticTerm) Adds the given semanticTerm
List<StereotypeModel>	getAllowedStereotypeModels()
Object	getDefaultValue()
Optional<DeprecationModel>	getDeprecation()
ParameterDslConfiguration	getDslConfiguration()
ExpressionSupport	getExpressionSupport()
List<FieldValueProviderModel>	getFieldValueProviderModels()
ParameterRole	getRole()
Set<String>	getSemanticTerms()
org.mule.metadata.api.model.MetadataType	getType()
ValueProviderModel	getValueProviderModel()
boolean	hasDynamicType()
boolean	isComponentId()
boolean	isConfigOverride()
boolean	isRequired()
void	setAllowedStereotypeModels(List<StereotypeModel> allowedStereotypeModels)
void	setComponentId(boolean componentId)
void	setConfigOverride(boolean isConfigOverride)
void	setDefaultValue(Object defaultValue)
void	setDslConfiguration(ParameterDslConfiguration dslConfiguration)
void	setExpressionSupport(ExpressionSupport expressionSupport)
void	setFieldValueProviderModels(List<FieldValueProviderModel> fieldValueProviderModels)
void	setParameterRole(ParameterRole parameterRole)
void	setRequired(boolean required)
void	setType(org.mule.metadata.api.model.MetadataType type, boolean isDynamic) Associates the given MetadataType to the element being declared
void	setValueProviderModel(ValueProviderModel valueProviderModel)
void	withDeprecation(DeprecationModel deprecation)

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.AbstractParameterDeclaration

getLayoutModel, setLayoutModel

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.NamedDeclaration

getName

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration

addModelProperty, getDescription, getDisplayModel, getModelProperties, getModelProperty, setDescription, setDisplayModel

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDeclaration

public ParameterDeclaration(String name)

Method Detail

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getExpressionSupport

public ExpressionSupport getExpressionSupport()

setExpressionSupport

public void setExpressionSupport(ExpressionSupport expressionSupport)

getDefaultValue

public Object getDefaultValue()

setDefaultValue

public void setDefaultValue(Object defaultValue)

getType

public org.mule.metadata.api.model.MetadataType getType()

Specified by:

getType in interface TypedDeclaration

Returns:

the declared MetadataType of the element

setType

public void setType(org.mule.metadata.api.model.MetadataType type,
                    boolean isDynamic)

Associates the given MetadataType to the element being declared

Specified by:

setType in interface TypedDeclaration

Parameters:

type - the element's static MetadataType

isDynamic - whether or not the element being declare supports a dynamic resolution of it's type, regardless of the type statically associated

hasDynamicType

public boolean hasDynamicType()

Specified by:

hasDynamicType in interface TypedDeclaration

Returns:

true if the element's type has support to be resolved dynamically

getDslConfiguration

public ParameterDslConfiguration getDslConfiguration()

setDslConfiguration

public void setDslConfiguration(ParameterDslConfiguration dslConfiguration)

getRole

public ParameterRole getRole()

setParameterRole

public void setParameterRole(ParameterRole parameterRole)

isConfigOverride

public boolean isConfigOverride()

setConfigOverride

public void setConfigOverride(boolean isConfigOverride)

getValueProviderModel

public ValueProviderModel getValueProviderModel()

setValueProviderModel

public void setValueProviderModel(ValueProviderModel valueProviderModel)

getFieldValueProviderModels

public List<FieldValueProviderModel> getFieldValueProviderModels()

setFieldValueProviderModels

public void setFieldValueProviderModels(List<FieldValueProviderModel> fieldValueProviderModels)

setAllowedStereotypeModels

public void setAllowedStereotypeModels(List<StereotypeModel> allowedStereotypeModels)

getAllowedStereotypeModels

public List<StereotypeModel> getAllowedStereotypeModels()

isComponentId

public boolean isComponentId()

setComponentId

public void setComponentId(boolean componentId)

getDeprecation

public Optional<DeprecationModel> getDeprecation()

Specified by:

getDeprecation in interface WithDeprecatedDeclaration

Returns:

this components DeprecationModel

withDeprecation

public void withDeprecation(DeprecationModel deprecation)

Specified by:

withDeprecation in interface WithDeprecatedDeclaration

Parameters:

deprecation - this components DeprecationModel

getSemanticTerms

public Set<String> getSemanticTerms()

Specified by:

getSemanticTerms in interface WithSemanticTermsDeclaration

Since:

1.4.0

addSemanticTerm

public void addSemanticTerm(String semanticTerm)

Adds the given semanticTerm

Specified by:

addSemanticTerm in interface WithSemanticTermsDeclaration

Parameters:

semanticTerm - a semantic term which describes the

Since:

1.4.0