facets.util
Class TracerInput

java.lang.Object
  facets.util.TracerInput

public class TracerInput
extends java.lang.Object

Reads from the console using a Tracer for output.

Method Summary

static java.io.File	getFile(Tracer tracer, java.io.File dir, FileSpecifier specifier) Encapsulates getting a file using console input.
java.lang.Object	getInput(Tracer tracer) Returns a value following console input.
static java.lang.Object	getItemChoice(Tracer tracer, java.lang.String rubricTop, java.lang.Object[] items, java.lang.String... optionNames) Returns a value chosen from a list.
static java.lang.Object	getItemChoice(Tracer tracer, java.lang.String rubric, java.lang.String[] items) Cover for getItemChoice(Tracer, String, Object[], String...).
protected java.lang.Object	newValidInput(java.lang.String read) Processes console input.
static void	pause(java.lang.String msg) Convenience method for pausing at the console.

Methods inherited from class java.lang.Object

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

Method Detail

getInput

public final java.lang.Object getInput(Tracer tracer)

Returns a value following console input.

Parameters:

tracer - issues the messages passed to the constructor

Returns:

non-null return from newValidInput(String) or null if quit requested

newValidInput

protected java.lang.Object newValidInput(java.lang.String read)

Processes console input.

Parameters:

read - passed from from System.in by getInput(Tracer)

Returns:

by default read; may convert this to some other value, or null to signal invalid input

pause

public static void pause(java.lang.String msg)

Convenience method for pausing at the console.

Parameters:

msg - incorporated into pause prompt

getFile

public static java.io.File getFile(Tracer tracer,
                                   java.io.File dir,
                                   FileSpecifier specifier)

Encapsulates getting a file using console input.

Uses getItemChoice(Tracer, String, String[]).

Parameters:

tracer - issues messages

dir - starting directory

specifier - filters files found

Returns:

a valid file below dir or null if abandoned

getItemChoice

public static java.lang.Object getItemChoice(Tracer tracer,
                                             java.lang.String rubric,
                                             java.lang.String[] items)

Cover for getItemChoice(Tracer, String, Object[], String...).

getItemChoice

public static java.lang.Object getItemChoice(Tracer tracer,
                                             java.lang.String rubricTop,
                                             java.lang.Object[] items,
                                             java.lang.String... optionNames)

Returns a value chosen from a list.

Parameters:

tracer - issues messages

rubricTop - appears before prompt

items - to choose

optionNames - listed as choices and checked against input

Returns:

a valid value or null if abandoned