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

Interface ParameterGroupModelParser

All Known Implementing Classes:

JavaDeclaredParameterGroupModelParser, JavaDefaultParameterGroupParser

public interface ParameterGroupModelParser

Parses the syntactic definition of a ParameterGroupModel 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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ParameterGroupModelParser.ExclusiveOptionalDescriptor Describes the group's exclusive optional parameters

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 group level which are specifically linked to the type of syntax used to define the extension.
String	getDescription()
Optional<org.mule.runtime.api.meta.model.display.DisplayModel>	getDisplayModel()
Optional<ParameterGroupModelParser.ExclusiveOptionalDescriptor>	getExclusiveOptionals() A ParameterGroupModelParser.ExclusiveOptionalDescriptor describing the groups exclusive optional parameters, if any were defined
Optional<org.mule.runtime.api.meta.model.display.LayoutModel>	getLayoutModel()
String	getName()
List<ParameterModelParser>	getParameterParsers() Returns a list with a ParameterModelParser per each parameter defined in the group.
boolean	showsInDsl()

Method Detail

getName

String getName()

Returns:

the group's name

getDescription

String getDescription()

Returns:

the group's description

getParameterParsers

List<ParameterModelParser> getParameterParsers()

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

Returns:

a list with the config's ParameterModelParser

getDisplayModel

Optional<org.mule.runtime.api.meta.model.display.DisplayModel> getDisplayModel()

Returns:

a DisplayModel if one was defined

getLayoutModel

Optional<org.mule.runtime.api.meta.model.display.LayoutModel> getLayoutModel()

Returns:

a LayoutModel if one was defined

getExclusiveOptionals

Optional<ParameterGroupModelParser.ExclusiveOptionalDescriptor> getExclusiveOptionals()

A ParameterGroupModelParser.ExclusiveOptionalDescriptor describing the groups exclusive optional parameters, if any were defined

Returns:

an Optional ParameterGroupModelParser.ExclusiveOptionalDescriptor

showsInDsl

boolean showsInDsl()

Returns:

whether this group should be made explicit in the DSL

getAdditionalModelProperties

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

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

Returns:

a list with ModelProperty instances.