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

Interface ParameterModel

All Superinterfaces:

Described, EnrichableModel, Named, Typed

All Known Implementing Classes:

ImmutableParameterModel

public interface ParameterModel
extends Named, Described, EnrichableModel, Typed

A parameter of a Component or Configuration

A parameter provides a name, a type and a default value.

It can apply either to a ConfigurationModel or a ComponentModel

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	RESERVED_NAMES

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
boolean	isRequired() Whether or not this parameter is required.

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

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

getType, hasDynamicType

Field Detail

RESERVED_NAMES

static final Set<String> RESERVED_NAMES

Method Detail

isRequired

boolean isRequired()

Whether or not this parameter is required. This method is exclusive with 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

Returns:

a boolean value saying if this parameter is required or not

getExpressionSupport

ExpressionSupport getExpressionSupport()

The level of support this parameter has for expressions

Returns:

a ExpressionSupport

getDefaultValue

Object getDefaultValue()

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

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

Returns:

the default value