org.mule.extension.introspection

Interface Parameter

All Superinterfaces:

Capable, Described

public interface Parameter
extends Described, Capable

A parameter of an operation or configuration

A parameter provides a name and

It can apply either to a Configuration or a Operation

Since:

1.0

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue() The default value for this parameter.
DataType	getType() Returns the type of the parameter
boolean	isDynamic() A parameter is considered to be dynamic if it's value can change in runtime depending on contextual circumstances.
boolean	isRequired() Whether or not this parameter is required.

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

getDescription, getName

Methods inherited from interface org.mule.extension.introspection.Capable

getCapabilities, isCapableOf

Field Detail

RESERVED_NAMES

static final Set<String> RESERVED_NAMES

Method Detail

getType

DataType getType()

Returns the type of the parameter

Returns:

a not null DataType

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

isDynamic

boolean isDynamic()

A parameter is considered to be dynamic if it's value can change in runtime depending on contextual circumstances. E.g.: the parameter value is a MEL expression or can be dynamically changed by a third party

Returns:

whether this parameter is dynamic or not

getDefaultValue

Object getDefaultValue()

The default value for this parameter. It might be an expression if isDynamic() returns true. 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