org.ametys.runtime.config

Class ConfigParameterParser

java.lang.Object

org.ametys.runtime.parameter.AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

org.ametys.runtime.config.ConfigParameterParser

public class ConfigParameterParser
extends AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

This class parses the configuration parameters to help SAX them later.

Field Summary

Fields inherited from class org.ametys.runtime.parameter.AbstractParameterParser

_enumeratorManager, _validatorManager

Constructor Summary

Constructors

Constructor and Description
ConfigParameterParser(ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager) The configuration parameter parser constructor.

Method Summary

Modifier and Type	Method and Description
protected void	_additionalParsing(ServiceManager manager, String pluginName, Configuration parameterConfig, String parameterId, ConfigParameter parameter) Called for additional parsing. Default implementation does nothing.
protected ConfigParameter	_createParameter(Configuration parameterConfig) Create the parameter to populate it.
protected Object	_parseDefaultValue(Configuration parameterConfig, ConfigParameter parameter) Parses the default value.
protected DisableConditions	_parseDisableConditions(Configuration disableConditionConfiguration) Parses the disable condition.
protected String	_parseId(Configuration parameterConfig) Parses the id.
protected ParameterHelper.ParameterType	_parseType(Configuration parameterConfig) Parses the type.

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

_parseAndSetEnumerator, _parseAndSetValidator, _parseI18nizableText, _parseWidget, _parseWidgetParameters, lookupComponents, parseParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigParameterParser

public ConfigParameterParser(ThreadSafeComponentManager<Enumerator> enumeratorManager,
                             ThreadSafeComponentManager<Validator> validatorManager)

The configuration parameter parser constructor.

Parameters:

enumeratorManager - The manager for enumarators

validatorManager - The manager for validators

Method Detail

_createParameter

protected ConfigParameter _createParameter(Configuration parameterConfig)
                                    throws ConfigurationException

Description copied from class: AbstractParameterParser

Create the parameter to populate it.

Specified by:

_createParameter in class AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the parameter instantiated.

Throws:

ConfigurationException - if the configuration is not valid.

_parseId

protected String _parseId(Configuration parameterConfig)
                   throws ConfigurationException

Description copied from class: AbstractParameterParser

Parses the id.

Specified by:

_parseId in class AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the id.

Throws:

ConfigurationException - if the configuration is not valid.

_parseType

protected ParameterHelper.ParameterType _parseType(Configuration parameterConfig)
                                            throws ConfigurationException

Description copied from class: AbstractParameterParser

Parses the type.

Specified by:

_parseType in class AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

Parameters:

parameterConfig - the parameter configuration to use.

Returns:

the type.

Throws:

ConfigurationException - if the configuration is not valid.

_parseDefaultValue

protected Object _parseDefaultValue(Configuration parameterConfig,
                                    ConfigParameter parameter)

Description copied from class: AbstractParameterParser

Parses the default value.

Specified by:

_parseDefaultValue in class AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

Parameters:

parameterConfig - the parameter configuration.

parameter - the parameter.

Returns:

the default value or null if none defined.

_parseDisableConditions

protected DisableConditions _parseDisableConditions(Configuration disableConditionConfiguration)
                                             throws ConfigurationException

Parses the disable condition.

Parameters:

disableConditionConfiguration - the configuration of the disable condition

Returns:

result the parsed disable condition to be converted in JSON

Throws:

ConfigurationException - if an error occurred

_additionalParsing

protected void _additionalParsing(ServiceManager manager,
                                  String pluginName,
                                  Configuration parameterConfig,
                                  String parameterId,
                                  ConfigParameter parameter)
                           throws ConfigurationException

Description copied from class: AbstractParameterParser

Called for additional parsing.
Default implementation does nothing.

Overrides:

_additionalParsing in class AbstractParameterParser<ConfigParameter,ParameterHelper.ParameterType>

Parameters:

manager - the sservice manager.

pluginName - the plugin name.

parameterConfig - the parameter configuration.

parameterId - the parameter id.

parameter - the parameter to populate.

Throws:

ConfigurationException - if the configuration is not valid.