org.marketcetera.util.auth
Class ConsoleSetter<T extends Holder<?>>

java.lang.Object
  org.marketcetera.util.auth.Setter<T>
      org.marketcetera.util.auth.ConsoleSetter<T>

Direct Known Subclasses:

ConsoleSetterCharArray, ConsoleSetterString

public abstract class ConsoleSetter<T extends Holder<?>>
extends Setter<T>

A setter that obtains holder data via the console. It is supported by a ConsoleContext.

Since:

0.5.0

Version:

$Id: ConsoleSetter.java 16154 2012-07-14 16:34:05Z colin $

Author:

tlerios@marketcetera.com

Constructor Summary

ConsoleSetter(T holder, I18NBoundMessage usage, I18NBoundMessage prompt)
Constructor mirroring superclass constructor.

Method Summary

I18NBoundMessage	getPrompt() Returns the receiver's prompt.
abstract void	setValue(Console console) Sets the holder's data by obtaining it from the given console, after displaying the receiver's prompt.

Methods inherited from class org.marketcetera.util.auth.Setter

getHolder, getUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleSetter

public ConsoleSetter(T holder,
                     I18NBoundMessage usage,
                     I18NBoundMessage prompt)

Constructor mirroring superclass constructor. The given prompt is displayed on the console when the user is queried for the holder's data.

Parameters:

prompt - The prompt.

See Also:

Setter.Setter(Holder,I18NBoundMessage)

Method Detail

getPrompt

public I18NBoundMessage getPrompt()

Returns the receiver's prompt.

Returns:

The prompt.

setValue

public abstract void setValue(Console console)

Sets the holder's data by obtaining it from the given console, after displaying the receiver's prompt. This method is called by a ConsoleContext.

Parameters:

console - The console.