org.mule.extension.introspection.declaration.fluent

Class OperationDescriptor

java.lang.Object

org.mule.extension.introspection.declaration.fluent.OperationDescriptor

All Implemented Interfaces:

Descriptor, HasCapabilities<OperationDescriptor>

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

A Descriptor 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
OperationDescriptor	describedAs(String description) Adds a description
OperationDescriptor	executorsCreatedBy(OperationExecutorFactory executorFactory) Specifies the OperationExecutorFactory to be used to create OperationExecutor instances.
DeclarationDescriptor	getRootDeclaration() Returns the root element of this declaration
WithParameters	with()
OperationDescriptor	withCapability(Object capability) Adds the given capability to the declaring operation
ConfigurationDescriptor	withConfig(String name) Adds another configuration to the root DeclarationDescriptor
OperationDescriptor	withOperation(String name) Adds another operation to the root DeclarationDescriptor

Methods inherited from class java.lang.Object

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

Method Detail

describedAs

public OperationDescriptor describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

descriptor

with

public WithParameters with()

Returns:

a WithParameters which allows adding ParameterDeclaration to this descriptor

addParameter

protected void addParameter(ParameterDeclaration parameter)

Adds a ParameterDeclaration

Parameters:

parameter - a ParameterDeclaration

getRootDeclaration

public DeclarationDescriptor getRootDeclaration()

Description copied from interface: Descriptor

Returns the root element of this declaration

Specified by:

getRootDeclaration in interface Descriptor

Returns:

the root DeclarationDescriptor

executorsCreatedBy

public OperationDescriptor executorsCreatedBy(OperationExecutorFactory executorFactory)

Specifies the OperationExecutorFactory to be used to create OperationExecutor instances.

Parameters:

executorFactory - a OperationExecutorFactory

Returns:

descriptor

withOperation

public OperationDescriptor withOperation(String name)

Adds another operation to the root DeclarationDescriptor

Parameters:

name - the name of the operation

Returns:

a new OperationDescriptor

withConfig

public ConfigurationDescriptor withConfig(String name)

Adds another configuration to the root DeclarationDescriptor

Parameters:

name - the name of the configuration

Returns:

a new ConfigurationDescriptor

withCapability

public OperationDescriptor withCapability(Object capability)

Adds the given capability to the declaring operation

Specified by:

withCapability in interface HasCapabilities<OperationDescriptor>

Parameters:

capability - a not null capability

Returns:

descriptor