org.ametys.runtime.config

Class ConfigParameter

java.lang.Object

org.ametys.runtime.parameter.Parameter<ParameterHelper.ParameterType>

org.ametys.runtime.config.ConfigParameter

All Implemented Interfaces:

Comparable<ConfigParameter>

public class ConfigParameter
extends Parameter<ParameterHelper.ParameterType>
implements Comparable<ConfigParameter>

This class represents a configuration parameter

Field Summary

Fields

Modifier and Type	Field and Description
private DisableConditions	_disableConditions
private I18nizableText	_displayCategory
private I18nizableText	_displayGroup
private boolean	_groupSwitch
private JsonFactory	_jsonFactory
private ObjectMapper	_objectMapper
private long	_order

Constructor Summary

Constructors

Constructor and Description
ConfigParameter()

Method Summary

Modifier and Type	Method and Description
private Map<String,String>	_disableConditionAsMap(DisableCondition disableCondition) Formats an Object into JSON.
private Map<String,Object>	_disableConditionsAsMap(DisableConditions disableConditions)
int	compareTo(ConfigParameter o)
String	disableConditionsToJSON() Formats disable conditions into JSON.
DisableConditions	getDisableConditions() Retrieves the disable condition.
I18nizableText	getDisplayCategory() Retrieves the display category of the parameter.
I18nizableText	getDisplayGroup() Retrieves the display group of the parameter
long	getOrder() Retrieves the order of a parameter
boolean	isGroupSwitch() Retrieves the group switch of the parameter if it has one, null otherwise
void	setDisableConditions(DisableConditions disableConditions) Sets the disable condition.
void	setDisplayCategory(I18nizableText displayCategory) Sets the display category of the parameter.
void	setDisplayGroup(I18nizableText displayGroup) Sets the display group of the parameter
void	setGroupSwitch(boolean groupSwitch) Sets the group switch of a parameter
void	setOrder(long order) Sets the order of the parameter

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getType, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

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

Field Detail

_displayCategory

private I18nizableText _displayCategory

_displayGroup

private I18nizableText _displayGroup

_groupSwitch

private boolean _groupSwitch

_order

private long _order

_disableConditions

private DisableConditions _disableConditions

_jsonFactory

private final JsonFactory _jsonFactory

_objectMapper

private final ObjectMapper _objectMapper

Constructor Detail

ConfigParameter

public ConfigParameter()

Method Detail

getDisplayCategory

public I18nizableText getDisplayCategory()

Retrieves the display category of the parameter.

Returns:

_displayCategory the display category

setDisplayCategory

public void setDisplayCategory(I18nizableText displayCategory)

Sets the display category of the parameter.

Parameters:

displayCategory - The category of the parameter

getDisplayGroup

public I18nizableText getDisplayGroup()

Retrieves the display group of the parameter

Returns:

_displayGroup the display group

setDisplayGroup

public void setDisplayGroup(I18nizableText displayGroup)

Sets the display group of the parameter

Parameters:

displayGroup - the display group

isGroupSwitch

public boolean isGroupSwitch()

Retrieves the group switch of the parameter if it has one, null otherwise

Returns:

_groupSwitch the group-switch

setGroupSwitch

public void setGroupSwitch(boolean groupSwitch)

Sets the group switch of a parameter

Parameters:

groupSwitch - the group switch

getOrder

public long getOrder()

Retrieves the order of a parameter

Returns:

_order the order

setOrder

public void setOrder(long order)

Sets the order of the parameter

Parameters:

order - the order

getDisableConditions

public DisableConditions getDisableConditions()

Retrieves the disable condition.

Returns:

the disable condition or null if none is defined.

setDisableConditions

public void setDisableConditions(DisableConditions disableConditions)

Sets the disable condition.

Parameters:

disableConditions - the disable condition.

compareTo

public int compareTo(ConfigParameter o)

Specified by:

compareTo in interface Comparable<ConfigParameter>

disableConditionsToJSON

public String disableConditionsToJSON()

Formats disable conditions into JSON.

Returns:

the Object as a JSON string.

_disableConditionsAsMap

private Map<String,Object> _disableConditionsAsMap(DisableConditions disableConditions)

_disableConditionAsMap

private Map<String,String> _disableConditionAsMap(DisableCondition disableCondition)

Formats an Object into JSON.

Parameters:

disableCondition - The disable condition to convert

Returns:

the Object as a JSON string.