Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.crosswire.common.config
Class IntOptionsChoice

    java.lang.Object
      org.crosswire.common.config.AbstractReflectedChoice
          org.crosswire.common.config.IntOptionsChoice

All Implemented Interfaces:
  Choice, MappedChoice<Integer,String>

    public class IntOptionsChoice

extends AbstractReflectedChoice
implements MappedChoice<Integer,String>

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
`private Map<Integer,String>` | `options`

Constructor Summary
`IntOptionsChoice()`

Method Summary
`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<Integer>` | `getConversionClass()` The class that this Choice works on.
`Map<Integer,String>` | `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<Integer,String> options

Constructor Detail

### IntOptionsChoice

    public IntOptionsChoice()

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<Integer,String> 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<Integer,String>`
  Returns:
    A string array of alternatives.

### getConversionClass

    public Class<Integer> 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Copyright ¨ 2003-2015
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD