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

Class ComponentDeclarer<T extends ComponentDeclarer,D extends ComponentDeclaration>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

HasModelProperties<ComponentDeclarer>

Direct Known Subclasses:

OperationDeclarer, RouterDeclarer, ScopeDeclarer, SourceDeclarer

public abstract class ComponentDeclarer<T extends ComponentDeclarer,D extends ComponentDeclaration>
extends ConfigurableOutputDeclarer<D>
implements HasModelProperties<ComponentDeclarer>

Allows configuring a ComponentDeclaration through a fluent API

Since:

1.0

Field Summary

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

declaration

Constructor Summary

Constructors

Constructor and Description
ComponentDeclarer(D declaration) Creates a new instance

Method Summary

Modifier and Type	Method and Description
T	describedAs(String description) Adds a 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
T	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
T	withStereotype(Stereotype stereotype) Adds the given stereotype

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

withOutput, withOutputAttributes

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

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

Constructor Detail

ComponentDeclarer

public ComponentDeclarer(D declaration)

Creates a new instance

Parameters:

declaration - the ComponentDeclaration which will be configured

Method Detail

describedAs

public T describedAs(String description)

Adds a description

Parameters:

description - a description

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

withModelProperty

public T withModelProperty(ModelProperty modelProperty)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<ComponentDeclarer>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer

withStereotype

public T withStereotype(Stereotype stereotype)

Adds the given stereotype

Parameters:

stereotype - a Stereotype

Returns:

this declarer