org.ametys.runtime.config

Class ConfigParameterGroup

java.lang.Object

org.ametys.runtime.config.ConfigParameterGroup

public class ConfigParameterGroup
extends Object

Represent a group of parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private I18nizableText	_groupLabel
private Map<String,ConfigParameter>	_groupParams
private Set<ConfigParameterCheckerDescriptor>	_paramCheckers
private String	_switcher

Constructor Summary

Constructors

Constructor and Description
ConfigParameterGroup(I18nizableText groupLabel) Create a group

Method Summary

Modifier and Type	Method and Description
(package private) void	addParam(ConfigParameter param)
(package private) void	addParamChecker(ConfigParameterCheckerDescriptor paramChecker)
I18nizableText	getLabel() Returns the label.
Set<ConfigParameterCheckerDescriptor>	getParamCheckers() Returns the ParameterCheckerDescriptors associated with this group.
ConfigParameter	getParameter(String id) Returns the named ConfigParameter.
Set<ConfigParameter>	getParams(boolean withSwitch) Returns the ConfigParameter contained in this group.
String	getSwitch() Returns the group switch, if any.

Methods inherited from class java.lang.Object

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

Field Detail

_groupParams

private Map<String,ConfigParameter> _groupParams

_switcher

private String _switcher

_groupLabel

private I18nizableText _groupLabel

_paramCheckers

private Set<ConfigParameterCheckerDescriptor> _paramCheckers

Constructor Detail

ConfigParameterGroup

public ConfigParameterGroup(I18nizableText groupLabel)

Create a group

Parameters:

groupLabel - The label of the group

Method Detail

addParam

void addParam(ConfigParameter param)

addParamChecker

void addParamChecker(ConfigParameterCheckerDescriptor paramChecker)

getParamCheckers

public Set<ConfigParameterCheckerDescriptor> getParamCheckers()

Returns the ParameterCheckerDescriptors associated with this group.

Returns:

the ParameterCheckerDescriptors associated with this group.

getLabel

public I18nizableText getLabel()

Returns the label.

Returns:

the label.

getParams

public Set<ConfigParameter> getParams(boolean withSwitch)

Returns the ConfigParameter contained in this group.

Parameters:

withSwitch - if the returned parameters should contains the group switcher, if any.

Returns:

the ConfigParameter contained in this group.

getParameter

public ConfigParameter getParameter(String id)

Returns the named ConfigParameter.

Parameters:

id - the id to retrieve.

Returns:

the named ConfigParameter.

getSwitch

public String getSwitch()

Returns the group switch, if any.

Returns:

the group switch, if any.