org.mule.runtime.api.meta.model.declaration.fluent

Class ParameterGroupDeclarer<D extends ParameterGroupDeclaration>

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.Declarer<D>

org.mule.runtime.api.meta.model.declaration.fluent.ParameterGroupDeclarer<D>

All Implemented Interfaces:

HasDisplayModelDeclarer<ParameterGroupDeclarer<D>>, HasModelProperties<ParameterGroupDeclarer<D>>

public class ParameterGroupDeclarer<D extends ParameterGroupDeclaration>
extends Declarer<D>
implements HasModelProperties<ParameterGroupDeclarer<D>>, HasDisplayModelDeclarer<ParameterGroupDeclarer<D>>

Allows configuring a ParameterGroupDeclaration through a fluent API

Since:

1.0

Field Summary

Fields inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

declaration

Constructor Summary

Constructors

Constructor and Description
ParameterGroupDeclarer(D declaration) Creates a new instance

Method Summary

Modifier and Type	Method and Description
ParameterGroupDeclarer<D>	withDisplayModel(DisplayModel displayModel) Sets the given displayModel
ParameterGroupDeclarer<D>	withDslInlineRepresentation(boolean showInDsl) Sets the DSL representation type to be either inline, where the group is represented as a child element, or implicit, where the group is shown as a set of attributes in the element.
ParameterGroupDeclarer<D>	withExclusiveOptionals(Set<String> parameterNames, boolean requiresOne)
ParameterGroupDeclarer<D>	withLayout(LayoutModel layoutModel) Sets the given layoutModel
ParameterGroupDeclarer<D>	withModelProperty(ModelProperty modelProperty) Adds the given modelProperty
OptionalParameterDeclarer	withOptionalParameter(String name) Adds an optional parameter
ParameterDeclarer	withRequiredParameter(String name) Adds a required parameter

Methods inherited from class org.mule.runtime.api.meta.model.declaration.fluent.Declarer

getDeclaration

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterGroupDeclarer

public ParameterGroupDeclarer(D declaration)

Creates a new instance

Parameters:

declaration - a declaration

Method Detail

withRequiredParameter

public ParameterDeclarer withRequiredParameter(String name)

Adds a required parameter

Parameters:

name - the name of the parameter

Returns:

a new ParameterDeclarer

withOptionalParameter

public OptionalParameterDeclarer withOptionalParameter(String name)

Adds an optional parameter

Parameters:

name - the name of the parameter

Returns:

a new OptionalParameterDeclarer

withExclusiveOptionals

public ParameterGroupDeclarer<D> withExclusiveOptionals(Set<String> parameterNames,
                                                        boolean requiresOne)

withDslInlineRepresentation

public ParameterGroupDeclarer<D> withDslInlineRepresentation(boolean showInDsl)

Sets the DSL representation type to be either inline, where the group is represented as a child element, or implicit, where the group is shown as a set of attributes in the element.

Parameters:

showInDsl - true if the group is shown in the DSL

Returns:

this ParameterGroupDeclarer

withLayout

public ParameterGroupDeclarer<D> withLayout(LayoutModel layoutModel)

Sets the given layoutModel

Parameters:

layoutModel - a LayoutModel

Returns:

this declarer

withModelProperty

public ParameterGroupDeclarer<D> withModelProperty(ModelProperty modelProperty)

Adds the given modelProperty

Specified by:

withModelProperty in interface HasModelProperties<ParameterGroupDeclarer<D extends ParameterGroupDeclaration>>

Parameters:

modelProperty - a ModelProperty

Returns:

this declarer

withDisplayModel

public ParameterGroupDeclarer<D> withDisplayModel(DisplayModel displayModel)

Sets the given displayModel

Specified by:

withDisplayModel in interface HasDisplayModelDeclarer<ParameterGroupDeclarer<D extends ParameterGroupDeclaration>>

Parameters:

displayModel - a DisplayModel

Returns:

this declarer