org.mule.extension.introspection.declaration

Class DeclarationConstruct

java.lang.Object

org.mule.extension.introspection.declaration.DeclarationConstruct

All Implemented Interfaces:

Construct, HasCapabilities<DeclarationConstruct>

public class DeclarationConstruct
extends Object
implements Construct, HasCapabilities<DeclarationConstruct>

A Construct which allows configuring a Declaration through a fluent API

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
DeclarationConstruct(String name, String version) Constructor for this construct

Method Summary

Methods

Modifier and Type	Method and Description
DeclarationConstruct	describedAs(String description) Adds a description
Declaration	getDeclaration()
DeclarationConstruct	getRootConstruct() Returns the root element of this construct
DeclarationConstruct	withCapability(Object capability) Adds the given capability to this declaration
ConfigurationConstruct	withConfig(String name) Adds a config of the given name
OperationConstruct	withOperation(String name) Adds an operation of the given name

Methods inherited from class java.lang.Object

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

Constructor Detail

DeclarationConstruct

public DeclarationConstruct(String name,
                    String version)

Constructor for this construct

Parameters:

name - a non blank name

version - a non blank version

Method Detail

describedAs

public DeclarationConstruct describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

this construct

withConfig

public ConfigurationConstruct withConfig(String name)

Adds a config of the given name

Parameters:

name - a non blank name

Returns:

a ConfigurationConstruct which allows describing the created configuration

withOperation

public OperationConstruct withOperation(String name)

Adds an operation of the given name

Parameters:

name - a non blank name

Returns:

a OperationConstruct which allows describing the created operation

withCapability

public DeclarationConstruct withCapability(Object capability)

Adds the given capability to this declaration

Specified by:

withCapability in interface HasCapabilities<DeclarationConstruct>

Parameters:

capability - a not null capability

Returns:

this construct

getRootConstruct

public DeclarationConstruct getRootConstruct()

Description copied from interface: Construct

Returns the root element of this construct

Specified by:

getRootConstruct in interface Construct

Returns:

getDeclaration

public Declaration getDeclaration()

Returns:

the configured Declaration