Package org.ametys.core.userpref

Class UserPreferencesEnumerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.core.userpref.UserPreferencesEnumerator

All Implemented Interfaces:

Enumerator<String>, Enumerator, Contextualizable, LogEnabled, Serviceable

Direct Known Subclasses:

FOUserPreferencesEnumerator

public class UserPreferencesEnumerator
extends AbstractLogEnabled
implements Enumerator<String>, Enumerator, Contextualizable, Serviceable

Enumerates user preferences.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected UserPreferencesExtensionPoint	_userPrefEP	The user preferences extension point.

Constructor Summary

Constructors

Constructor	Description
UserPreferencesEnumerator()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
Map<String,Object>	getConfiguration()	Get the configuration of this enumerator
protected Map<String,String>	getContextVars()	Get the preferences context variables.
Map<Object,I18nizableText>	getEntries()	Provides the enumerated values with their optional label.
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

_userPrefEP

protected UserPreferencesExtensionPoint _userPrefEP

The user preferences extension point.

_context

protected Context _context

The avalon context

Constructor Details

UserPreferencesEnumerator

public UserPreferencesEnumerator()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()
                                           throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getTypedEntries in interface Enumerator<String>

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<String>

Specified by:

getEntry in interface Enumerator

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getContextVars

protected Map<String,String> getContextVars()

Get the preferences context variables.

Returns:

the preferences context as a Map.

getEntries

public Map<Object,I18nizableText> getEntries()
                                      throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Enumerator

Get the configuration of this enumerator

Specified by:

getConfiguration in interface Enumerator<String>

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration