net.objectlab.kit.console

Class ConsoleMenu

java.lang.Object

net.objectlab.kit.console.ConsoleMenu

public class ConsoleMenu
extends Object

Author:

Benoit Xhenseval

Constructor Summary

Constructors

Constructor and Description
ConsoleMenu(Repeater containingObject)

Method Summary

Modifier and Type	Method and Description
void	addMenuItem(String menuDisplay, String methodName, boolean repeat) add an entry in the menu, sequentially
void	displayMenu() display the menu, the application goes into a loop which provides the menu and fires the entries selected.
static BigDecimal	getBigDecimal(String title, BigDecimal defaultValue) Gets an BigDecimal from the System.in
static boolean	getBoolean(String title, boolean defaultValue) Gets a boolean from the System.in
static Date	getDate(String title, Date defaultValue)
static int	getInt(String title, int defaultValue) Gets an int from the System.in
static String	getPassword(String prompt)
static String	getString(String msg) Gets a String from the System.in.
static String	getString(String msg, String defaultVal) Gets a String from the System.in
static LocalDate	getYMD(String title, LocalDate defaultValue)
static String	selectOne(String title, String[] optionNames, String[] optionValues, int defaultOption) Generates a menu with a list of options and return the value selected.
void	setScreenColumns(int width)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleMenu

public ConsoleMenu(Repeater containingObject)

Parameters:

containingObject - the object that will be called back once an option is chosen in the menu

Method Detail

addMenuItem

public void addMenuItem(String menuDisplay,
                        String methodName,
                        boolean repeat)

add an entry in the menu, sequentially

Parameters:

menuDisplay - how the entry will be displayed in the menu

methodName - name of the public method

repeat - call back for repeat

setScreenColumns

public void setScreenColumns(int width)

displayMenu

public void displayMenu()

display the menu, the application goes into a loop which provides the menu and fires the entries selected. It automatically adds an entry to exit.

getInt

public static int getInt(String title,
                         int defaultValue)

Gets an int from the System.in

Parameters:

title - for the command line

defaultValue - defaultValue if title not found

Returns:

int as entered by the user of the console app

getBoolean

public static boolean getBoolean(String title,
                                 boolean defaultValue)

Gets a boolean from the System.in

Parameters:

title - for the command line

Returns:

boolean as selected by the user of the console app

getBigDecimal

public static BigDecimal getBigDecimal(String title,
                                       BigDecimal defaultValue)

Gets an BigDecimal from the System.in

Parameters:

title - for the command line

Returns:

int as entered by the user of the console app

getDate

public static Date getDate(String title,
                           Date defaultValue)

getYMD

public static LocalDate getYMD(String title,
                               LocalDate defaultValue)

getString

public static String getString(String msg)

Gets a String from the System.in.

Parameters:

msg - for the command line

Returns:

String as entered by the user of the console app

getString

public static String getString(String msg,
                               String defaultVal)

Gets a String from the System.in

Parameters:

msg - for the command line

Returns:

String as entered by the user of the console app

selectOne

public static String selectOne(String title,
                               String[] optionNames,
                               String[] optionValues,
                               int defaultOption)

Generates a menu with a list of options and return the value selected.

Parameters:

title - for the command line

optionNames - name for each option

optionValues - value for each option

Returns:

String as selected by the user of the console app

getPassword

public static String getPassword(String prompt)

Parameters:

prompt - The prompt to display to the user.

Returns:

The password as entered by the user.