org.mule.runtime.api.meta.model.declaration.fluent

Class ExecutableComponentDeclarer<T extends ExecutableComponentDeclarer,D extends ExecutableComponentDeclaration>

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.Declarer<D>

org.mule.runtime.api.meta.model.declaration.fluent.ParameterizedDeclarer<T,D>

org.mule.runtime.api.meta.model.declaration.fluent.ExecutableComponentDeclarer<T,D>

Type Parameters:

T - the generic type of the concrete declarer

D - the generic type of the produced OperationDeclaration

All Implemented Interfaces:

HasModelProperties<org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer>, HasNestedComponents, HasNestedRoutes, HasParametersDeclarer

Direct Known Subclasses:

OperationDeclarer, SourceDeclarer

public abstract class ExecutableComponentDeclarer<T extends ExecutableComponentDeclarer,D extends ExecutableComponentDeclaration>
extends ParameterizedDeclarer<T,D>

Base class for declarers which allow to construct an OperationDeclaration

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

declaration

Method Summary

Modifier and Type	Method and Description
T	requiresConnection(boolean requiresConnection) Specifies if this component requires a connection in order to perform its task
T	supportsStreaming(boolean supportsStreaming) Specifies if this component supports streaming.
T	transactional(boolean transactional) Specifies if this component has the ability to execute while joining a transaction
NestedChainDeclarer	withChain() Adds a component of the given name
NestedChainDeclarer	withChain(String chainName) Adds a component of the given name
NestedComponentDeclarer	withComponent(String nestedComponentName) Adds a component of the given name
T	withErrorModel(ErrorModel error) Adds an ErrorModel to indicate that the current operation could throw the added error.
T	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
NestedComponentDeclarer	withOptionalComponent(String nestedComponentName) Adds a component of the given name
OutputDeclarer	withOutput() Declares element output
OutputDeclarer	withOutputAttributes() Declares element output
NestedRouteDeclarer	withRoute(String routeName) Adds a component of the given name
T	withStereotype(StereotypeModel stereotype) Adds the given stereotype

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.ParameterizedDeclarer

describedAs, onDefaultParameterGroup, onParameterGroup

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

getDeclaration

Methods inherited from class java.lang.Object

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

Method Detail

withOutput

public OutputDeclarer withOutput()

Declares element output

Returns:

a new OutputDeclarer

withOutputAttributes

public OutputDeclarer withOutputAttributes()

Declares element output

Returns:

a new OutputDeclarer

withErrorModel

public T withErrorModel(ErrorModel error)

Adds an ErrorModel to indicate that the current operation could throw the added error.

Parameters:

error - ErrorModel to add to the OperationDeclaration

Returns:

this declarer

transactional

public T transactional(boolean transactional)

Specifies if this component has the ability to execute while joining a transaction

Parameters:

transactional - whether the component is transactional or not

Returns:

this declarer

requiresConnection

public T requiresConnection(boolean requiresConnection)

Specifies if this component requires a connection in order to perform its task

Parameters:

requiresConnection - whether the component requires a connection or not

Returns:

this declarer

supportsStreaming

public T supportsStreaming(boolean supportsStreaming)

Specifies if this component supports streaming. Notice that supporting streaming doesn't necessarily mean that streaming will be performed when the component is actually executed.

Parameters:

supportsStreaming - whether the component supports streaming or not

Returns:

this declarer

withOptionalComponent

public NestedComponentDeclarer withOptionalComponent(String nestedComponentName)

Adds a component of the given name

Specified by:

withOptionalComponent in interface HasNestedComponents

Parameters:

nestedComponentName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withComponent

public NestedComponentDeclarer withComponent(String nestedComponentName)

Adds a component of the given name

Specified by:

withComponent in interface HasNestedComponents

Parameters:

nestedComponentName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withChain

public NestedChainDeclarer withChain()

Adds a component of the given name

Specified by:

withChain in interface HasNestedComponents

Returns:

a NestedComponentDeclarer which allows describing the created component

withChain

public NestedChainDeclarer withChain(String chainName)

Adds a component of the given name

Specified by:

withChain in interface HasNestedComponents

Parameters:

chainName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withRoute

public NestedRouteDeclarer withRoute(String routeName)

Adds a component of the given name

Specified by:

withRoute in interface HasNestedRoutes

Parameters:

routeName - a non blank name

Returns:

a NestedComponentDeclarer which allows describing the created component

withStereotype

public T withStereotype(StereotypeModel stereotype)

Adds the given stereotype

Parameters:

stereotype - a StereotypeModel

Returns:

this declarer

withModelProperty

public T withModelProperty(ModelProperty modelProperty)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<org.mule.runtime.api.meta.model.declaration.fluent.ComponentDeclarer>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer