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

Class NestedComponentDeclarer<T extends NestedComponentDeclarer,D extends NestedComponentDeclaration>

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>

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

All Implemented Interfaces:

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

Direct Known Subclasses:

NestedChainDeclarer

public class NestedComponentDeclarer<T extends NestedComponentDeclarer,D extends NestedComponentDeclaration>
extends ComponentDeclarer<T,D>

Allows configuring a NestedComponentDeclaration 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
NestedComponentDeclarer(D declaration) Creates a new instance

Method Summary

Modifier and Type	Method and Description
T	describedAs(String description) Adds a description
NestedComponentDeclarer	withAllowedStereotypes(StereotypeModel... stereotypes) Adds the given stereotypes to the ones which are allowed on the route.
NestedComponentDeclarer<T,D>	withMaxOccurs(Integer maxOccurs) Sets the maximum amount of times that this component can be present on the owning one.
NestedComponentDeclarer<T,D>	withMinOccurs(int minOccurs) Sets the minimum amount of times that this component can be present on the owning one.
T	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
T	withStereotype(StereotypeModel stereotype) Adds the given stereotype

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

withChain, withChain, withComponent, withDeprecation, withErrorModel, withOptionalComponent, withRoute, withSemanticTerm

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

NestedComponentDeclarer

public NestedComponentDeclarer(D declaration)

Creates a new instance

Parameters:

declaration - the NestedComponentDeclaration to be configured

Method Detail

withAllowedStereotypes

public NestedComponentDeclarer withAllowedStereotypes(StereotypeModel... stereotypes)

Adds the given stereotypes to the ones which are allowed on the route.

Parameters:

stereotypes - the stereotypes to add

Returns:

this declarer

withModelProperty

public T withModelProperty(ModelProperty modelProperty)

Description copied from class: ComponentDeclarer

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<T extends NestedComponentDeclarer>

Overrides:

withModelProperty in class ComponentDeclarer<T extends NestedComponentDeclarer,D extends NestedComponentDeclaration>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer

describedAs

public T describedAs(String description)

Adds a description

Overrides:

describedAs in class ParameterizedDeclarer<T extends NestedComponentDeclarer,D extends NestedComponentDeclaration>

Parameters:

description - a description

Returns:

this declarer

withStereotype

public T withStereotype(StereotypeModel stereotype)

Adds the given stereotype

Specified by:

withStereotype in interface HasStereotypeDeclarer<T extends NestedComponentDeclarer>

Overrides:

withStereotype in class ComponentDeclarer<T extends NestedComponentDeclarer,D extends NestedComponentDeclaration>

Parameters:

stereotype - a StereotypeModel

Returns:

this declarer

withMinOccurs

public NestedComponentDeclarer<T,D> withMinOccurs(int minOccurs)

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

Setting this to zero means that the element becomes optional.

Parameters:

minOccurs - a value equal or greater than zero

Returns:

this declarer

withMaxOccurs

public NestedComponentDeclarer<T,D> withMaxOccurs(Integer maxOccurs)

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

Setting this to null means that repetitions are unbounded.

Parameters:

maxOccurs - a value greater or equal than zero

Returns:

this declarer