org.mule.runtime.api.meta.model.operation

Interface RouteModel

All Superinterfaces:

DescribedObject, NamedObject, ParameterizedModel

public interface RouteModel
extends ParameterizedModel

A Route is a chain of components which don't exist directly on a Mule flow, but are contained inside another owning component.

For example:

• The processors inside the <foreach> component are part of a route
• The processors inside the <when> block inside a choice router.

Each of the above constitute a Route. Several instances of those routes can exists inside the same component instance. For example, the when route can be used many times inside a choice router. On the other hand, the otherwise route inside the same router can only exist up to one time, while it is also allowed to not exist at all. This getMinOccurs() and getMaxOccurs() methods model that.

Finally, some scope have restrictions regarding which components can be used with them. For example, validation:all only allows other validators to be placed inside. That's what the getAllowedStereotypes() method represents.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Optional<Set<Stereotype>>	getAllowedStereotypes() Optional Set of stereotypes to which the components placed inside the route MUST conform to.
Optional<Integer>	getMaxOccurs() Optional value which represents the maximum amount of times that this route can be used inside the owning component.
int	getMinOccurs() Represents the minimum amount of times that this route can be used inside the owning component.

Methods inherited from interface org.mule.runtime.api.meta.model.parameter.ParameterizedModel

getAllParameterModels, getParameterGroupModels

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Methods inherited from interface org.mule.runtime.api.meta.DescribedObject

getDescription

Method Detail

getMinOccurs

int getMinOccurs()

Represents the minimum amount of times that this route can be used inside the owning component.

Returns:

An int greater or equal to zero

getMaxOccurs

Optional<Integer> getMaxOccurs()

Optional value which represents the maximum amount of times that this route can be used inside the owning component.

Returns:

If present, a number greater or equal to zero.

getAllowedStereotypes

Optional<Set<Stereotype>> getAllowedStereotypes()

Optional Set of stereotypes to which the components placed inside the route MUST conform to.

If the value is empty, it means that no restriction applies.

Returns:

If present, a non empty set