org.ametys.plugins.core.impl.userpref

Class StaticUserPreferenceProvider.UserPreferenceParser

java.lang.Object

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

org.ametys.plugins.core.impl.userpref.StaticUserPreferenceProvider.UserPreferenceParser

Enclosing class:

StaticUserPreferenceProvider

class StaticUserPreferenceProvider.UserPreferenceParser
extends AbstractParameterParser<UserPreference,ParameterHelper.ParameterType>

Parser for UserPreference.

Field Summary

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

_enumeratorManager, _validatorManager

Constructor Summary

Constructors

Constructor and Description
UserPreferenceParser(ThreadSafeComponentManager<Enumerator> enumeratorManager, ThreadSafeComponentManager<Validator> validatorManager)

Method Summary

Modifier and Type	Method and Description
protected void	_additionalParsing(ServiceManager manager, String pluginName, Configuration preferenceConfig, String parameterId, UserPreference preference) Called for additional parsing. Default implementation does nothing.
protected UserPreference	_createParameter(Configuration parameterConfig) Create the parameter to populate it.
protected Object	_parseDefaultValue(Configuration parameterConfig, UserPreference preference) Parses the default value.
protected String	_parseId(Configuration parameterConfig) Parses the id.
protected ParameterHelper.ParameterType	_parseType(Configuration parameterConfig) Parses the type.
protected Pattern	_parseWorkspace(Configuration configuration) Parse the workspace if any to create a pattern

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

UserPreferenceParser

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

Method Detail

_createParameter

protected UserPreference _createParameter(Configuration parameterConfig)
                                   throws ConfigurationException

Description copied from class: AbstractParameterParser

Create the parameter to populate it.

Specified by:

_createParameter in class AbstractParameterParser<UserPreference,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<UserPreference,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<UserPreference,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,
                                    UserPreference preference)

Description copied from class: AbstractParameterParser

Parses the default value.

Specified by:

_parseDefaultValue in class AbstractParameterParser<UserPreference,ParameterHelper.ParameterType>

Parameters:

parameterConfig - the parameter configuration.

preference - the parameter.

Returns:

the default value or null if none defined.

_parseWorkspace

protected Pattern _parseWorkspace(Configuration configuration)
                           throws ConfigurationException

Parse the workspace if any to create a pattern

Parameters:

configuration - The user pref configuration

Returns:

The pattern or null

Throws:

ConfigurationException - if the configuration is wrong

_additionalParsing

protected void _additionalParsing(ServiceManager manager,
                                  String pluginName,
                                  Configuration preferenceConfig,
                                  String parameterId,
                                  UserPreference preference)
                           throws ConfigurationException

Description copied from class: AbstractParameterParser

Called for additional parsing.
Default implementation does nothing.

Overrides:

_additionalParsing in class AbstractParameterParser<UserPreference,ParameterHelper.ParameterType>

Parameters:

manager - the sservice manager.

pluginName - the plugin name.

preferenceConfig - the parameter configuration.

parameterId - the parameter id.

preference - the parameter to populate.

Throws:

ConfigurationException - if the configuration is not valid.