org.mule.extension.introspection.declaration

Class ConfigurationConstruct

java.lang.Object

org.mule.extension.introspection.declaration.ConfigurationConstruct

All Implemented Interfaces:

Construct, HasCapabilities<ConfigurationConstruct>

public final class ConfigurationConstruct
extends Object
implements Construct, HasCapabilities<ConfigurationConstruct>

A Construct which allows configuring a ConfigurationDeclaration through a fluent API

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addParameter(ParameterDeclaration parameter) Adds the given parameter to the declaring configuration
ConfigurationConstruct	describedAs(String description) Adds a description to the configuration
DeclarationConstruct	getRootConstruct() Returns the owning DeclarationConstruct
ConfigurationConstruct	instantiatedWith(ConfigurationInstantiator configurationInstantiator) Specifies the ConfigurationInstantiator to be used to create instances of objects which are compliant with the declared configuration
WithParameters	with()
ConfigurationConstruct	withCapability(Object capability) Adds the given capability to the declaring configuration
ConfigurationConstruct	withConfig(String name) Adds another config of the given name

Methods inherited from class java.lang.Object

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

Method Detail

with

public WithParameters with()

Returns:

a WithParameters which allows adding parameters to the declaring configuration

describedAs

public ConfigurationConstruct describedAs(String description)

Adds a description to the configuration

Parameters:

description - a description

Returns:

this construct

addParameter

protected void addParameter(ParameterDeclaration parameter)

Adds the given parameter to the declaring configuration

Parameters:

parameter - a ParameterDeclaration

withCapability

public ConfigurationConstruct withCapability(Object capability)

Adds the given capability to the declaring configuration

Specified by:

withCapability in interface HasCapabilities<ConfigurationConstruct>

Parameters:

capability - a not null capability

Returns:

this construct

instantiatedWith

public ConfigurationConstruct instantiatedWith(ConfigurationInstantiator configurationInstantiator)

Specifies the ConfigurationInstantiator to be used to create instances of objects which are compliant with the declared configuration

Parameters:

configurationInstantiator - a ConfigurationInstantiator

Returns:

this 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

getRootConstruct

public DeclarationConstruct getRootConstruct()

Returns the owning DeclarationConstruct

Specified by:

getRootConstruct in interface Construct

Returns:

a DeclarationConstruct