com.gridsystems.config.tools.console
Class ConstantField

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

All Implemented Interfaces:

ConsoleViewAction

public class ConstantField
extends Field
implements ConsoleViewAction

Constant text field.

Version:

1.0

Author:

Rodrigo Ruiz Aguayo

Field Summary

protected java.lang.String	linePattern Pattern to use for field display.
protected java.lang.String	value The value.

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

bundle

Constructor Summary

ConstantField(java.util.ResourceBundle bundle, java.lang.String linePattern, java.lang.String value)
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.
void	setValue(java.lang.String 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.

value

protected java.lang.String value

The value.

Constructor Detail

ConstantField

public ConstantField(java.util.ResourceBundle bundle,
                     java.lang.String linePattern,
                     java.lang.String value)

Creates a new instance.

Parameters:

bundle - The resource bundle

linePattern - The pattern for field display

value - The value to display

Method Detail

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.String 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

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