org.mule.runtime.extension.api.model.parameter

Class ImmutableParameterModel

java.lang.Object

org.mule.runtime.extension.api.model.AbstractImmutableModel

org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

org.mule.runtime.extension.api.model.parameter.ImmutableParameterModel

All Implemented Interfaces:

DescribedObject, HasDisplayModel, HasLayoutModel, EnrichableModel, ParameterModel, NamedObject, Typed

public final class ImmutableParameterModel
extends AbstractNamedImmutableModel
implements ParameterModel

Immutable implementation of ParameterModel

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

description, modelProperties

Constructor Summary

Constructors

Constructor and Description

ImmutableParameterModel(String name, String description, MetadataType type, boolean hasDynamicType, boolean required, boolean isConfigOverride, ExpressionSupport expressionSupport, Object defaultValue, ParameterRole role, ParameterDslConfiguration dslConfiguration, DisplayModel displayModel, LayoutModel layoutModel, ValueProviderModel valueProviderModel, List<StereotypeModel> allowedStereotypeModels, Set<ModelProperty> modelProperties) Creates a new instance with the given state

Method Summary

Modifier and Type	Method and Description
List<StereotypeModel>	getAllowedStereotypes()
Object	getDefaultValue() The default value for this parameter.
ParameterDslConfiguration	getDslConfiguration()
ExpressionSupport	getExpressionSupport() The level of support this parameter has for expressions
Optional<LayoutModel>	getLayoutModel() The value of LayoutModel.getOrder() is to be consider relative to the owning ParameterGroupModel
ParameterRole	getRole()
MetadataType	getType() Returns the MetadataType of the Typed component.
Optional<ValueProviderModel>	getValueProviderModel()
boolean	hasDynamicType() Returns true if the type of the Component is of dynamic kind, and has to be discovered during design time using the MetadataService service.
boolean	isOverrideFromConfig() Whether or not this parameter is bound to a ParameterModel of the same name and type that exists in the config associated to the container of this parameter.
boolean	isRequired() Whether or not this parameter is required.

Methods inherited from class org.mule.runtime.extension.api.model.AbstractNamedImmutableModel

checkArgument, equals, getDisplayModel, getName, hashCode, toString

Methods inherited from class org.mule.runtime.extension.api.model.AbstractImmutableModel

copy, copy, getDescription, getModelProperties, getModelProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Methods inherited from interface org.mule.runtime.api.meta.model.EnrichableModel

getModelProperties, getModelProperty

Methods inherited from interface org.mule.runtime.api.meta.model.display.HasDisplayModel

getDisplayModel

Constructor Detail

ImmutableParameterModel

public ImmutableParameterModel(String name,
                               String description,
                               MetadataType type,
                               boolean hasDynamicType,
                               boolean required,
                               boolean isConfigOverride,
                               ExpressionSupport expressionSupport,
                               Object defaultValue,
                               ParameterRole role,
                               ParameterDslConfiguration dslConfiguration,
                               DisplayModel displayModel,
                               LayoutModel layoutModel,
                               ValueProviderModel valueProviderModel,
                               List<StereotypeModel> allowedStereotypeModels,
                               Set<ModelProperty> modelProperties)

Creates a new instance with the given state

Parameters:

name - the parameter's name. Cannot be blank.

description - the parameter's description

type - the parameter's MetadataType. Cannot be null

hasDynamicType - if the given type is of dynamic kind and has to be discovered during design time

required - whether this parameter is required or not

expressionSupport - the ExpressionSupport that applies to this ParameterModel

defaultValue - this parameter's default value

role - this parameter's purpose

dslConfiguration - a model which describes the DSL semantics for this parameter

displayModel - a model which contains directive about how the parameter is displayed in the UI

layoutModel - a model which contains directives about the parameter's layout in the UI

allowedStereotypeModels - A Set with the stereotypes of the allowed values

modelProperties - A Set of custom properties which extend this model

Throws:

IllegalArgumentException - if required is true and defaultValue is not null at the same time

Method Detail

getType

public MetadataType getType()

Returns the MetadataType of the Typed component.

Specified by:

getType in interface Typed

Returns:

a not null MetadataType

hasDynamicType

public boolean hasDynamicType()

Description copied from interface: Typed

Returns true if the type of the Component is of dynamic kind, and has to be discovered during design time using the MetadataService service.

Specified by:

hasDynamicType in interface Typed

Returns:

true if this element type is of dynamic kind

isRequired

public boolean isRequired()

Whether or not this parameter is required. This method is exclusive with ParameterModel.getDefaultValue() in the sense that a required parameter cannot have a default value. At the same time, if the parameter has a default value, then it makes no sense to consider it as required

Specified by:

isRequired in interface ParameterModel

Returns:

a boolean value saying if this parameter is required or not

isOverrideFromConfig

public boolean isOverrideFromConfig()

Whether or not this parameter is bound to a ParameterModel of the same name and type that exists in the config associated to the container of this parameter.
When true, the parameter will be injected with the same value of the bound parameter of the config that's been associated to the execution.

Specified by:

isOverrideFromConfig in interface ParameterModel

Returns:

a boolean value saying if this parameter acts as an override for a parameter defined in a config.

getExpressionSupport

public ExpressionSupport getExpressionSupport()

The level of support this parameter has for expressions

Specified by:

getExpressionSupport in interface ParameterModel

Returns:

a ExpressionSupport

getDefaultValue

public Object getDefaultValue()

The default value for this parameter. It might be an expression if ParameterModel.getExpressionSupport() returns ExpressionSupport.REQUIRED or ExpressionSupport.SUPPORTED.

This method is exclusive with ParameterModel.isRequired(). Check that method's comments for more information on the semantics of this two methods.

Specified by:

getDefaultValue in interface ParameterModel

Returns:

the default value

getDslConfiguration

public ParameterDslConfiguration getDslConfiguration()

Specified by:

getDslConfiguration in interface ParameterModel

Returns:

A ParameterDslConfigurationwhich describes the language which allows configuring this parameter

getRole

public ParameterRole getRole()

Specified by:

getRole in interface ParameterModel

Returns:

this ParameterModel's role

getLayoutModel

public Optional<LayoutModel> getLayoutModel()

The value of LayoutModel.getOrder() is to be consider relative to the owning ParameterGroupModel

Specified by:

getLayoutModel in interface HasLayoutModel

Specified by:

getLayoutModel in interface ParameterModel

Returns:

An Optional LayoutModel which contains directives about how this parameter should be shown in the UI

getAllowedStereotypes

public List<StereotypeModel> getAllowedStereotypes()

Specified by:

getAllowedStereotypes in interface ParameterModel

Returns:

a List of StereotypeModels that this ParameterModel should accept values of.

getValueProviderModel

public Optional<ValueProviderModel> getValueProviderModel()

Specified by:

getValueProviderModel in interface ParameterModel

Returns:

A ValueProviderModel to communicate if the this parameter model is capable to provide values. an Optional.empty() if there is no model associate to this parameter.