org.mule.extension.introspection.declaration.fluent

Class ConfigurationDescriptor

java.lang.Object

org.mule.extension.introspection.declaration.fluent.ConfigurationDescriptor

All Implemented Interfaces:

Descriptor, HasCapabilities<ConfigurationDescriptor>

public final class ConfigurationDescriptor
extends Object
implements Descriptor, HasCapabilities<ConfigurationDescriptor>

A Descriptor 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
ConfigurationDescriptor	describedAs(String description) Adds a description to the configuration
DeclarationDescriptor	getRootDeclaration() Returns the root DeclarationDescriptor
ConfigurationDescriptor	instantiatedWith(ConfigurationInstantiator configurationInstantiator) Specifies the ConfigurationInstantiator to be used to create instances of objects which are compliant with the declared configuration
WithParameters	with()
ConfigurationDescriptor	withCapability(Object capability) Adds the given capability to the declaring configuration
ConfigurationDescriptor	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 ConfigurationDescriptor describedAs(String description)

Adds a description to the configuration

Parameters:

description - a description

Returns:

this descriptor

addParameter

protected void addParameter(ParameterDeclaration parameter)

Adds the given parameter to the declaring configuration

Parameters:

parameter - a ParameterDeclaration

withCapability

public ConfigurationDescriptor withCapability(Object capability)

Adds the given capability to the declaring configuration

Specified by:

withCapability in interface HasCapabilities<ConfigurationDescriptor>

Parameters:

capability - a not null capability

Returns:

this descriptor

instantiatedWith

public ConfigurationDescriptor 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 descriptor

withConfig

public ConfigurationDescriptor withConfig(String name)

Adds another config of the given name

Parameters:

name - the name of the config

Returns:

a new ConfigurationDescriptor

getRootDeclaration

public DeclarationDescriptor getRootDeclaration()

Returns the root DeclarationDescriptor

Specified by:

getRootDeclaration in interface Descriptor

Returns:

a DeclarationDescriptor