org.crosswire.common.config

Class MappedOptionsChoice

java.lang.Object

org.crosswire.common.config.AbstractReflectedChoice

org.crosswire.common.config.MappedOptionsChoice

All Implemented Interfaces:

Choice, MappedChoice<Object,Object>

public class MappedOptionsChoice
extends AbstractReflectedChoice
implements MappedChoice<Object,Object>

A class to convert between strings and objects of a type.

Author:

Joe Walker, DM Smith

See Also:

The GNU Lesser General Public License for details.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	log The log stream
private Map<?,?>	options

Constructor Summary

Constructors

Constructor and Description
MappedOptionsChoice()

Method Summary

Methods

Modifier and Type	Method and Description
Object	convertToObject(String orig) Convert from a stored string to an object to use with reflection
String	convertToString(Object orig) Convert from a reflection return value to a String for storage
Class<String>	getConversionClass() The class that this Choice works on.
Map<Object,Object>	getOptions() The available alternative values to be presented as options to the user where the user interface allows presentation of alternatives.
void	init(org.jdom2.Element option, ResourceBundle configResources) String value to associate with the name (key)

Methods inherited from class org.crosswire.common.config.AbstractReflectedChoice

getFullPath, getHelpText, getKey, getString, getType, isHidden, isIgnored, isSaveable, requiresRestart, setFullPath, setHelpText, setString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.crosswire.common.config.Choice

getFullPath, getHelpText, getKey, getString, getType, isHidden, isIgnored, isSaveable, requiresRestart, setFullPath, setHelpText, setString

Field Detail

options

private Map<?,?> options

log

private static org.slf4j.Logger log

The log stream

Constructor Detail

MappedOptionsChoice

public MappedOptionsChoice()

Method Detail

init

public void init(org.jdom2.Element option,
        ResourceBundle configResources)
          throws StartupException

Description copied from interface: Choice

String value to associate with the name (key)

Specified by:

init in interface Choice

Overrides:

init in class AbstractReflectedChoice

Parameters:

option - the option

configResources - the resource bundle to load

Throws:

StartupException - if startup is not possible

getOptions

public Map<Object,Object> getOptions()

Description copied from interface: MappedChoice

The available alternative values to be presented as options to the user where the user interface allows presentation of alternatives.

Specified by:

getOptions in interface MappedChoice<Object,Object>

Returns:

A string array of alternatives.

getConversionClass

public Class<String> getConversionClass()

Description copied from interface: Choice

The class that this Choice works on. Used to decide how to display the choice to the user.

Specified by:

getConversionClass in interface Choice

Returns:

The Class that this Choice works using.

convertToString

public String convertToString(Object orig)

Description copied from class: AbstractReflectedChoice

Convert from a reflection return value to a String for storage

Specified by:

convertToString in class AbstractReflectedChoice

Parameters:

orig - the object to be converted to a string

Returns:

the marshaled representation of the object

convertToObject

public Object convertToObject(String orig)

Description copied from class: AbstractReflectedChoice

Convert from a stored string to an object to use with reflection

Specified by:

convertToObject in class AbstractReflectedChoice

Parameters:

orig - the marshaled representation of the object

Returns:

the reconstituted object