org.mule.extension.introspection.declaration

Class ParameterDeclaration

java.lang.Object

org.mule.extension.introspection.declaration.CapableDeclaration<ParameterDeclaration>

org.mule.extension.introspection.declaration.ParameterDeclaration

All Implemented Interfaces:

Capable, Described

public final class ParameterDeclaration
extends CapableDeclaration<ParameterDeclaration>
implements Described

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

By default, isDynamic() returns true and getDescription() returns an empty String.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
Object	getDefaultValue()
String	getDescription() Returns the component's description
String	getName() Returns the component's name
DataType	getType()
boolean	isDynamic()
boolean	isRequired()
void	setDefaultValue(Object defaultValue)
void	setDescription(String description)
void	setDynamic(boolean dynamic)
void	setName(String name)
void	setRequired(boolean required)
void	setType(DataType type)

Methods inherited from class org.mule.extension.introspection.declaration.CapableDeclaration

addCapability, getCapabilities, getCapabilities, isCapableOf

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Description copied from interface: Described

Returns the component's name

Specified by:

getName in interface Described

Returns:

a non blank String

setName

public void setName(String name)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean dynamic)

getType

public DataType getType()

setType

public void setType(DataType type)

getDescription

public String getDescription()

Description copied from interface: Described

Returns the component's description

Specified by:

getDescription in interface Described

Returns:

a non blank String

setDescription

public void setDescription(String description)

getDefaultValue

public Object getDefaultValue()

setDefaultValue

public void setDefaultValue(Object defaultValue)