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

Class NestedRouteDeclarer

java.lang.Object

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

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

All Implemented Interfaces:

HasModelProperties<NestedRouteDeclarer>, HasNestedComponentsDeclarer, HasParametersDeclarer

public class NestedRouteDeclarer
extends Declarer<NestedRouteDeclaration>
implements HasModelProperties<NestedRouteDeclarer>, HasNestedComponentsDeclarer, HasParametersDeclarer

Allows configuring a NestedComponentDeclaration through a fluent API.

Keep in mind that Routes are required to have at least one child component, which translate to almost always having to invoke the withChain() method of this declarer.

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
NestedRouteDeclarer(NestedRouteDeclaration declaration) Creates a new instance

Method Summary

Modifier and Type	Method and Description
NestedRouteDeclarer	describedAs(String description) Adds a description
NestedRouteDeclaration	getDeclaration()
ParameterGroupDeclarer	onDefaultParameterGroup() Provides the default ParameterGroupDeclarer.
ParameterGroupDeclarer	onParameterGroup(String name) Provides a ParameterGroupDeclarer for adding parameters into a group of the given name.
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
NestedRouteDeclarer	withMaxOccurs(Integer maxOccurs) Sets the maximum amount of times that this route can be present on the owning component
NestedRouteDeclarer	withMinOccurs(int minOccurs) Sets the minimum amount of times that this route can be present on the owning component
NestedRouteDeclarer	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
NestedComponentDeclarer	withOptionalComponent(String nestedComponentName) Adds a component of the given name

Methods inherited from class java.lang.Object

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

Constructor Detail

NestedRouteDeclarer

public NestedRouteDeclarer(NestedRouteDeclaration declaration)

Creates a new instance

Parameters:

declaration - the NestedComponentDeclaration to be configured

Method Detail

withMinOccurs

public NestedRouteDeclarer withMinOccurs(int minOccurs)

Sets the minimum amount of times that this route can be present on the owning component

Parameters:

minOccurs - a value equal or greater than zero

Returns:

this declarer

withMaxOccurs

public NestedRouteDeclarer withMaxOccurs(Integer maxOccurs)

Sets the maximum amount of times that this route can be present on the owning component

Parameters:

maxOccurs - a value greater or equal than zero

Returns:

this declarer

getDeclaration

public NestedRouteDeclaration getDeclaration()

Overrides:

getDeclaration in class Declarer<NestedRouteDeclaration>

Returns:

The created declaration

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

onParameterGroup

public ParameterGroupDeclarer onParameterGroup(String name)

Provides a ParameterGroupDeclarer for adding parameters into a group of the given name. Use this if you wish to declare a parameter which should belong to a specific group.

Specified by:

onParameterGroup in interface HasParametersDeclarer

Parameters:

name - the name of the group to declare

Returns:

a ParameterGroupDeclarer

onDefaultParameterGroup

public ParameterGroupDeclarer onDefaultParameterGroup()

Provides the default ParameterGroupDeclarer. Use this if you wish to add a parameter which shouldn't belong to any specific group.

Specified by:

onDefaultParameterGroup in interface HasParametersDeclarer

Returns:

a ParameterGroupDeclarer

withModelProperty

public NestedRouteDeclarer withModelProperty(ModelProperty modelProperty)

Description copied from interface: HasModelProperties

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<NestedRouteDeclarer>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer

describedAs

public NestedRouteDeclarer describedAs(String description)

Adds a description

Parameters:

description - a description

Returns:

this declarer