org.mule.extension.introspection.declaration

Class OperationConstruct

java.lang.Object

org.mule.extension.introspection.declaration.OperationConstruct

All Implemented Interfaces:

Construct, HasCapabilities<OperationConstruct>

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

A Construct which allows configuring a OperationDeclaration through a fluent API

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addParameter(ParameterDeclaration parameter) Adds a ParameterDeclaration
OperationConstruct	describedAs(String description) Adds a description
OperationConstruct	executorsCreatedBy(OperationExecutorFactory executorFactory) Specifies the OperationExecutorFactory to be used to create OperationExecutor instances.
DeclarationConstruct	getRootConstruct() Returns the root element of this construct
WithParameters	with()
OperationConstruct	withCapability(Object capability) Adds the given capability to the declaring operation
ConfigurationConstruct	withConfig(String name) Adds another configuration to the root DeclarationConstruct
OperationConstruct	withOperation(String name) Adds another operation to the root DeclarationConstruct

Methods inherited from class java.lang.Object

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

Method Detail

describedAs

public OperationConstruct describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

construct

with

public WithParameters with()

Returns:

a WithParameters which allows adding ParameterDeclaration to this construct

addParameter

protected void addParameter(ParameterDeclaration parameter)

Adds a ParameterDeclaration

Parameters:

parameter - a ParameterDeclaration

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

executorsCreatedBy

public OperationConstruct executorsCreatedBy(OperationExecutorFactory executorFactory)

Specifies the OperationExecutorFactory to be used to create OperationExecutor instances.

Parameters:

executorFactory - a OperationExecutorFactory

Returns:

construct

withOperation

public OperationConstruct withOperation(String name)

Adds another operation to the root DeclarationConstruct

Parameters:

name - the name of the operation

Returns:

a new OperationConstruct

withConfig

public ConfigurationConstruct withConfig(String name)

Adds another configuration to the root DeclarationConstruct

Parameters:

name - the name of the configuration

Returns:

a new ConfigurationConstruct

withCapability

public OperationConstruct withCapability(Object capability)

Adds the given capability to the declaring operation

Specified by:

withCapability in interface HasCapabilities<OperationConstruct>

Parameters:

capability - a not null capability

Returns:

construct