org.mule.runtime.extension.api.introspection.parameter

Class ImmutableParameterModel

java.lang.Object

org.mule.runtime.extension.api.introspection.AbstractImmutableModel

org.mule.runtime.extension.api.introspection.AbstractNamedImmutableModel

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

All Implemented Interfaces:

Described, EnrichableModel, Named, ParameterModel, Typed

public final class ImmutableParameterModel
extends AbstractNamedImmutableModel
implements ParameterModel

Immutable implementation of ParameterModel

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.extension.api.introspection.parameter.ParameterModel

RESERVED_NAMES

Constructor Summary

Constructors

Constructor and Description
ImmutableParameterModel(String name, String description, org.mule.metadata.api.model.MetadataType type, boolean hasDynamicType, boolean required, ExpressionSupport expressionSupport, Object defaultValue, Set<ModelProperty> modelProperties) Creates a new instance with the given state

Method Summary

Modifier and Type	Method and Description
Object	getDefaultValue() The default value for this parameter.
ExpressionSupport	getExpressionSupport() The level of support this parameter has for expressions
org.mule.metadata.api.model.MetadataType	getType() Returns the MetadataType of the Typed component.
boolean	hasDynamicType() Returns true if the type of the Component is of dynamic kind, and has to be discovered during design time using the MetadataManager service.
boolean	isRequired() Whether or not this parameter is required.

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

checkArgument, equals, getName, hashCode, toString

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

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.extension.api.introspection.Named

getName

Methods inherited from interface org.mule.runtime.extension.api.introspection.Described

getDescription

Methods inherited from interface org.mule.runtime.extension.api.introspection.EnrichableModel

getModelProperties, getModelProperty

Constructor Detail

ImmutableParameterModel

public ImmutableParameterModel(String name,
                               String description,
                               org.mule.metadata.api.model.MetadataType type,
                               boolean hasDynamicType,
                               boolean required,
                               ExpressionSupport expressionSupport,
                               Object defaultValue,
                               Set<ModelProperty> modelProperties)

Creates a new instance with the given state

Parameters:

name - the parameter's name. Cannot be blank and cannot be one of the values in ParameterModel.RESERVED_NAMES

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

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 org.mule.metadata.api.model.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 MetadataManager 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

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