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

Class ParameterGroupDeclaration

java.lang.Object

org.mule.runtime.api.meta.model.declaration.fluent.BaseDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.NamedDeclaration<T>

org.mule.runtime.api.meta.model.declaration.fluent.AbstractParameterDeclaration<ParameterGroupDeclaration>

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

All Implemented Interfaces:

DescribedObject, NamedObject

public class ParameterGroupDeclaration
extends AbstractParameterDeclaration<ParameterGroupDeclaration>

A declaration object for a ParameterGroupModel. It contains raw, unvalidated data which is used to declare the structure of a ParameterGroupModel.

Since:

1.0

Field Summary

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

layoutModel

Constructor Summary

Constructors

Constructor and Description
ParameterGroupDeclaration(String name)

Method Summary

Modifier and Type	Method and Description
ParameterGroupDeclaration	addExclusiveParameters(Set<String> parameterNames, boolean requiresOne)
ParameterGroupDeclaration	addParameter(ParameterDeclaration parameter) Adds a ParameterDeclaration
List<ExclusiveParametersDeclaration>	getExclusiveParameters()
List<ParameterDeclaration>	getParameters()
boolean	isShowInDsl()
void	showInDsl(boolean showInDsl) Sets the declaration of whether this ParameterDeclaration represents a ParameterGroupModel that will be shown inline in the DSL or instead is represented as a set of standalone attributes.

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

getLayoutModel, setLayoutModel

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

getName

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

addModelProperty, getDescription, getDisplayModel, getModelProperties, getModelProperty, setDescription, setDisplayModel

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterGroupDeclaration

public ParameterGroupDeclaration(String name)

Method Detail

getParameters

public List<ParameterDeclaration> getParameters()

Returns:

an unmodifiable List with the declarations registered through addParameter(ParameterDeclaration)

addParameter

public ParameterGroupDeclaration addParameter(ParameterDeclaration parameter)

Adds a ParameterDeclaration

Parameters:

parameter - a not null ParameterDeclaration

Returns:

this declaration

Throws:

{@link - IllegalArgumentException} if parameter is null

addExclusiveParameters

public ParameterGroupDeclaration addExclusiveParameters(Set<String> parameterNames,
                                                        boolean requiresOne)

getExclusiveParameters

public List<ExclusiveParametersDeclaration> getExclusiveParameters()

showInDsl

public void showInDsl(boolean showInDsl)

Sets the declaration of whether this ParameterDeclaration represents a ParameterGroupModel that will be shown inline in the DSL or instead is represented as a set of standalone attributes.

Parameters:

showInDsl - true if the group should be shown explicitly inline in the DSL

isShowInDsl

public boolean isShowInDsl()

Returns:

true if the ParameterGroupModel has to be shown inline in the DSL