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

Class JavaDeclaredParameterGroupModelParser

java.lang.Object

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

All Implemented Interfaces:

ParameterGroupModelParser

public class JavaDeclaredParameterGroupModelParser
extends Object

Java based implementation of ParameterGroupModelParser for non-default parameter groups explicitly defined in the extension's code.

Since:

4.5.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.module.extension.internal.loader.parser.ParameterGroupModelParser

ParameterGroupModelParser.ExclusiveOptionalDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<ParameterModelParser,ParameterModelParser>	parameterMutator

Constructor Summary

Constructors

Constructor and Description
JavaDeclaredParameterGroupModelParser(ExtensionParameter groupParameter, ParameterDeclarationContext context, Function<ParameterModelParser,ParameterModelParser> parameterMutator)

Method Summary

Modifier and Type	Method and Description
protected Stream<ExtensionParameter>	doGetParameters()
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()

Methods inherited from class java.lang.Object

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

Field Detail

parameterMutator

protected final Function<ParameterModelParser,ParameterModelParser> parameterMutator

Constructor Detail

JavaDeclaredParameterGroupModelParser

public JavaDeclaredParameterGroupModelParser(ExtensionParameter groupParameter,
                                             ParameterDeclarationContext context,
                                             Function<ParameterModelParser,ParameterModelParser> parameterMutator)

Method Detail

getName

public String getName()

Returns:

the group's name

getDescription

public String getDescription()

Returns:

the group's description

doGetParameters

protected Stream<ExtensionParameter> doGetParameters()

getDisplayModel

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

Returns:

a DisplayModel if one was defined

getLayoutModel

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

Returns:

a LayoutModel if one was defined

getExclusiveOptionals

public Optional<ParameterGroupModelParser.ExclusiveOptionalDescriptor> getExclusiveOptionals()

Description copied from interface: ParameterGroupModelParser

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

Returns:

an Optional ParameterGroupModelParser.ExclusiveOptionalDescriptor

showsInDsl

public boolean showsInDsl()

Returns:

whether this group should be made explicit in the DSL

getAdditionalModelProperties

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

Description copied from interface: ParameterGroupModelParser

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.

getParameterParsers

public final List<ParameterModelParser> getParameterParsers()

Description copied from interface: ParameterGroupModelParser

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.

Specified by:

getParameterParsers in interface ParameterGroupModelParser

Returns:

a list with the config's ParameterModelParser