com.gridsystems.config.tools.console
Class SelectionField

java.lang.Object
  com.gridsystems.config.tools.console.Field
      com.gridsystems.config.tools.console.SelectionField

All Implemented Interfaces:

ConsoleViewAction

public class SelectionField
extends Field
implements ConsoleViewAction

Asks the user to chose between a list of valid values.

Author:

SJM.

Field Summary

protected java.lang.String	linePattern Pattern to use for field display.
protected java.lang.Object	value The value.
protected java.text.MessageFormat	valueFormatter A cached instance of the value formatter.
protected java.lang.String	valuePattern Pattern to use for value display and parsing.

Fields inherited from class com.gridsystems.config.tools.console.Field

bundle

Constructor Summary

SelectionField(java.util.ResourceBundle bundle, java.lang.String linePattern, java.lang.String valuePattern, java.lang.String[] values)
Creates a new instance.

Method Summary

boolean	execute(ConsoleConfiguratorView view) Asks the user for the new value for this field.
java.lang.String[]	getContents() Gets the contents of this field.
java.lang.String	getKeyMapping() Gets the key mapping of this action.
protected java.lang.String	getStringValue() Gets the field value as a string.
java.lang.Object	getValue() Gets this field value.
protected java.lang.String	readLine() Reads a line of text from the console.
protected void	setStringValue(java.lang.String newValue) Sets the field value from the specified string.
void	setValue(java.lang.Object value) Sets the value of this field.

Methods inherited from class com.gridsystems.config.tools.console.Field

getString

Methods inherited from class java.lang.Object

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

Field Detail

linePattern

protected java.lang.String linePattern

Pattern to use for field display.

valuePattern

protected java.lang.String valuePattern

Pattern to use for value display and parsing.

value

protected java.lang.Object value

The value.

valueFormatter

protected java.text.MessageFormat valueFormatter

A cached instance of the value formatter.

Constructor Detail

SelectionField

public SelectionField(java.util.ResourceBundle bundle,
                      java.lang.String linePattern,
                      java.lang.String valuePattern,
                      java.lang.String[] values)

Creates a new instance.

Parameters:

bundle - The resource bundle

linePattern - The pattern for field display

valuePattern - The pattern for value display and parsing

values - a String[] with the list of allowed values.

Method Detail

execute

public boolean execute(ConsoleConfiguratorView view)

Asks the user for the new value for this field. The empty string means to maintain the current value.

To specify an empty value, in trimmed fields a blank space can be used

This method does not return until the default value or a valid one is specified.

Specified by:

execute in interface ConsoleViewAction

Parameters:

view - The view where this field is located

Returns:

It always returns true, as the edition does not imply an exit from the view execution loop.

See Also:

ConsoleViewAction

readLine

protected java.lang.String readLine()
                             throws java.io.IOException

Reads a line of text from the console.

Returns:

The read text

Throws:

java.io.IOException - If an error occurs while reading from the console

getKeyMapping

public java.lang.String getKeyMapping()

Gets the key mapping of this action.

Specified by:

getKeyMapping in interface ConsoleViewAction

Returns:

The key mapping of this action

getContents

public java.lang.String[] getContents()

Gets the contents of this field.

Specified by:

getContents in class Field

Returns:

The contents of this field

getValue

public java.lang.Object getValue()

Gets this field value.

Returns:

The value

setValue

public void setValue(java.lang.Object value)

Sets the value of this field.

Parameters:

value - The new value

getStringValue

protected java.lang.String getStringValue()

Gets the field value as a string.

Returns:

A string containing this field value

setStringValue

protected void setStringValue(java.lang.String newValue)

Sets the field value from the specified string. If not null, the value pattern will be used for parsing the text

Parameters:

newValue - The text containing the new value