org.mule.runtime.module.extension.internal.loader.parser

Interface NestedRouteModelParser

All Superinterfaces:

AllowedStereotypesModelParser, SemanticTermsParser

All Known Implementing Classes:

JavaNestedRouteModelParser

public interface NestedRouteModelParser
extends SemanticTermsParser, AllowedStereotypesModelParser

Parses the syntactic definition of a NestedRouteModel so that the semantics reflected in it can be extracted in a uniform way, regardless of the actual syntax used by the extension developer.

Since:

4.5.0

See Also:

ExtensionModelParser

Method Summary

Modifier and Type	Method and Description
List<org.mule.runtime.api.meta.model.ModelProperty>	getAdditionalModelProperties() Returns a list with all the model properties to be applied at the route level which are specifically linked to the type of syntax used to define the extension.
Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel>	getDeprecationModel()
String	getDescription()
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.
String	getName()
List<ParameterGroupModelParser>	getParameterGroupModelParsers() Returns a list with a ParameterGroupModelParser per each parameter group defined in the route.

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.SemanticTermsParser

getSemanticTerms

Methods inherited from interface org.mule.runtime.module.extension.internal.loader.parser.AllowedStereotypesModelParser

getAllowedStereotypes

Method Detail

getName

String getName()

Returns:

the route's name

getDescription

String getDescription()

Returns:

the route's description

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.

getParameterGroupModelParsers

List<ParameterGroupModelParser> getParameterGroupModelParsers()

Returns a list with a ParameterGroupModelParser per each parameter group defined in the route. Each group is listed in the same order as defined in the syntax.

Returns:

a list with the config's ParameterGroupModelParser

getAdditionalModelProperties

List<org.mule.runtime.api.meta.model.ModelProperty> getAdditionalModelProperties()

Returns a list with all the model properties to be applied at the route level which are specifically linked to the type of syntax used to define the extension.

Returns:

a list with ModelProperty instances.

getDeprecationModel

Optional<org.mule.runtime.api.meta.model.deprecated.DeprecationModel> getDeprecationModel()

Returns:

the router's DeprecationModel if one was defined