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<T,D>

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

All Implemented Interfaces:

HasDeprecatedDeclarer<T>, HasModelProperties<T>, HasNestedComponentsDeclarer, HasNestedRoutesDeclarer, HasParametersDeclarer, HasSemanticTermsDeclarer<T>, HasStereotypeDeclarer<T>

Direct Known Subclasses:

ConstructDeclarer, ExecutableComponentDeclarer, NestedComponentDeclarer

public abstract class ComponentDeclarer<T extends ComponentDeclarer,D extends ComponentDeclaration>
extends ParameterizedDeclarer<T,D>
implements HasModelProperties<T>, HasNestedComponentsDeclarer, HasNestedRoutesDeclarer, HasStereotypeDeclarer<T>, HasDeprecatedDeclarer<T>, HasSemanticTermsDeclarer<T>

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

Method Summary

Modifier and Type	Method and Description
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	withDeprecation(DeprecationModel deprecation) Adds the given stereotype
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
NestedRouteDeclarer	withRoute(String routeName) Adds a component of the given name
T	withSemanticTerm(String semanticTerm) Adds the given semanticTerm
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

withOptionalComponent

public NestedComponentDeclarer withOptionalComponent(String nestedComponentName)

Adds a component of the given name

Specified by:

withOptionalComponent in interface HasNestedComponentsDeclarer

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 HasNestedComponentsDeclarer

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 HasNestedComponentsDeclarer

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 HasNestedComponentsDeclarer

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 HasNestedRoutesDeclarer

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

Specified by:

withStereotype in interface HasStereotypeDeclarer<T extends ComponentDeclarer>

Parameters:

stereotype - a StereotypeModel

Returns:

this declarer

withModelProperty

public T withModelProperty(ModelProperty modelProperty)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<T extends ComponentDeclarer>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer

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

withDeprecation

public T withDeprecation(DeprecationModel deprecation)

Adds the given stereotype

Specified by:

withDeprecation in interface HasDeprecatedDeclarer<T extends ComponentDeclarer>

Parameters:

deprecation - a DeprecationModel

Returns:

this declarer

withSemanticTerm

public T withSemanticTerm(String semanticTerm)

Adds the given semanticTerm

Specified by:

withSemanticTerm in interface HasSemanticTermsDeclarer<T extends ComponentDeclarer>

Parameters:

semanticTerm - a semantic term

Returns:

this declarer

Since:

1.4.0