org.mule.extension.introspection.declaration

Class ParameterConstruct<T extends ParameterConstruct>

java.lang.Object

org.mule.extension.introspection.declaration.ParameterConstruct<T>

All Implemented Interfaces:

Construct, HasCapabilities<ParameterConstruct<T>>

Direct Known Subclasses:

OptionalParameterConstruct

public class ParameterConstruct<T extends ParameterConstruct>
extends Object
implements Construct, HasCapabilities<ParameterConstruct<T>>

A Construct which allows configuring a ParameterDeclaration through a fluent API

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
T	describedAs(String description) Adds a description
ParameterDeclaration	getDeclaration() Gets the declaration object for this construct
DeclarationConstruct	getRootConstruct() Returns the root element of this construct
T	ofType(Class<?> type, Class<?>... parametrizedTypes) Specifies the type of the Parameter and its parametrized types
T	ofType(DataType dataType) Specifies the type of the Parameter
T	whichIsDynamic() Specifies that the declared Parameter is to be dynamic (which is the default anyways...)
T	whichIsNotDynamic() Specifies that the declared Parameter is not to be dynamic
WithParameters	with()
ParameterConstruct<T>	withCapability(Object capability) Adds the given capability to the declaring parameter
ConfigurationConstruct	withConfig(String name) Adds another config of the given name
OperationConstruct	withOperation(String name) Adds another operation of the given name

Methods inherited from class java.lang.Object

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

Method Detail

ofType

public T ofType(Class<?> type,
       Class<?>... parametrizedTypes)

Specifies the type of the Parameter and its parametrized types

Parameters:

type - the type of the parameter

parametrizedTypes - the generic types for type

Returns:

construct

ofType

public T ofType(DataType dataType)

Specifies the type of the Parameter

Parameters:

dataType - the type of the parameter

Returns:

describedAs

public T describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

construct

whichIsNotDynamic

public T whichIsNotDynamic()

Specifies that the declared Parameter is not to be dynamic

Returns:

construct

whichIsDynamic

public T whichIsDynamic()

Specifies that the declared Parameter is to be dynamic (which is the default anyways...)

Returns:

construct

withConfig

public ConfigurationConstruct withConfig(String name)

Adds another config of the given name

Parameters:

name - the name of the config

Returns:

a new ConfigurationConstruct

withOperation

public OperationConstruct withOperation(String name)

Adds another operation of the given name

Parameters:

name - the name of the config

Returns:

a new OperationConstruct

with

public WithParameters with()

Returns:

a WithParameters that allows adding more parameters to the owning Construct

getRootConstruct

public DeclarationConstruct getRootConstruct()

Description copied from interface: Construct

Returns the root element of this construct

Specified by:

getRootConstruct in interface Construct

Returns:

the root DeclarationConstruct

withCapability

public ParameterConstruct<T> withCapability(Object capability)

Adds the given capability to the declaring parameter

Specified by:

withCapability in interface HasCapabilities<ParameterConstruct<T extends ParameterConstruct>>

Parameters:

capability - a not null capability

Returns:

construct

getDeclaration

public ParameterDeclaration getDeclaration()

Gets the declaration object for this construct

Returns:

a ParameterDeclaration