org.mule.runtime.extension.api.annotation.param

Annotation Type ParameterGroup

@Target(value={FIELD,PARAMETER})
 @Retention(value=RUNTIME)
 @Documented
public @interface ParameterGroup

Allows to define a group of parameters which share some kind of special relationship and thus makes sense for them to belong to the same group. This grouping is done by placing these parameters as fields of the same Java class, and then use that class alongside this annotation.

Unlike a regular pojo, the parameters defined in this class will be flattened and the owning ParameterizedModel will not contain any reference to the defining class.

For example:

     {@code

Since:

1.0

Field Summary

Fields

Modifier and Type	Fields and Description
static String	ADVANCED Group name for parameters that are considered for advanced usage.
static String	CONNECTION Group name for parameters that are considered to be part of a connection configuration.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the group being defined.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	showInDsl If true, the Group will be shown as an inline element of the DSL

Field Detail

ADVANCED

public static final String ADVANCED

Group name for parameters that are considered for advanced usage.

CONNECTION

public static final String CONNECTION

Group name for parameters that are considered to be part of a connection configuration.

Element Detail

name

public abstract String name

The name of the group being defined. This name cannot be equivalent to ParameterGroupModel.DEFAULT_GROUP_NAME

showInDsl

public abstract boolean showInDsl

If true, the Group will be shown as an inline element of the DSL

Default:

false