com.izforge.izpack.util

Class Console

java.lang.Object

com.izforge.izpack.util.Console

public class Console
extends Object

I/O streams to support prompting and keyboard input from the console.

Author:

Tim Anderson

Constructor Summary

Constructors

Constructor and Description
Console(InstallData installData, ConsolePrefs prefs) Constructs a Console with System.in and System.out as the I/O streams.

Method Summary

Modifier and Type	Method and Description
void	flush() Flush the console output stream.
void	print(String message) Prints a message to the console.
void	printFilledLine(char c)
void	println() Prints a new line.
void	println(String message) Prints a message to the console with a new line.
void	printMessageBox(String title, String message)
void	printMultiLine(String text, boolean wrap, boolean paging)
int	prompt(String prompt, int min, int max, int eof) Displays a prompt and waits for numeric input.
int	prompt(String prompt, int min, int max, int defaultValue, int eof) Displays a prompt and waits for numeric input.
String	prompt(String prompt, String defaultValue) Displays a prompt and waits for input.
String	prompt(String prompt, String[] values) Prompts for a value from a set of values.
String	prompt(String prompt, String[] values, String defaultValue) Prompts for a value from a set of values.
String	promptLocation(String prompt, String defaultValue) Displays a prompt and waits for input.
String	promptPassword(String prompt, String defaultValue) Displays a prompt and waits for input.
int	read() Read a character from the console.
String	readLine() Reads a line of text.

Methods inherited from class java.lang.Object

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

Constructor Detail

Console

public Console(InstallData installData,
               ConsolePrefs prefs)

Constructs a Console with System.in and System.out as the I/O streams.

Method Detail

read

public int read()
         throws IOException

Read a character from the console.

Returns:

The character, or -1 if an EOF is received.

Throws:

IOException - If an I/O error occurs

readLine

public String readLine()
                throws IOException

Reads a line of text. A line is considered to be terminated by any one of a line feed ('\\n'), a carriage return ('\\r'), or a carriage return followed immediately by a linefeed.

Returns:

a String containing the contents of the line, not including any line-termination characters, or null if the end of the stream has been reached

Throws:

IOException - if an I/O error occurs

flush

public void flush()
           throws IOException

Flush the console output stream.

Throws:

IOException - if an I/O error occurs

printMultiLine

public void printMultiLine(String text,
                           boolean wrap,
                           boolean paging)
                    throws IOException

Throws:

IOException

printFilledLine

public void printFilledLine(char c)

printMessageBox

public void printMessageBox(String title,
                            String message)

print

public void print(String message)

Prints a message to the console.

Parameters:

message - the message to print

println

public void println()

Prints a new line.

println

public void println(String message)

Prints a message to the console with a new line.

Parameters:

message - the message to print

prompt

public int prompt(String prompt,
                  int min,
                  int max,
                  int eof)

Displays a prompt and waits for numeric input.

Parameters:

prompt - the prompt to display

min - the minimum allowed value

max - the maximum allowed value

eof - the value to return if end of stream is reached

Returns:

a value in the range of from..to, or eof if the end of stream is reached

prompt

public int prompt(String prompt,
                  int min,
                  int max,
                  int defaultValue,
                  int eof)

Displays a prompt and waits for numeric input.

Parameters:

prompt - the prompt to display

min - the minimum allowed value

max - the maximum allowed value

defaultValue - the default value to use, if no input is entered. Use a value < min if there is no default

eof - the value to return if end of stream is reached

Returns:

a value in the range of from..to, or eof if the end of stream is reached

promptLocation

public String promptLocation(String prompt,
                             String defaultValue)

Displays a prompt and waits for input. Allows auto completion of files and directories. Except a path to a file or directory. Ensure to expand the tilde character to the user's home directory. If the input ends with a file separator we will trim it to keep consistency.

Parameters:

prompt - the prompt to display

defaultValue - the default value to use, if no input is entered

Returns:

the user input value; if the user input is empty (return key pressed) return defaultValue

promptPassword

public String promptPassword(String prompt,
                             String defaultValue)

Displays a prompt and waits for input. Expects a password, characters with be mased with the echoCharacter "*"

Parameters:

prompt - the prompt to display

defaultValue - the default value to use, if no input is entered

Returns:

the user input value; if the user input is empty (return key pressed) return defaultValue

prompt

public String prompt(String prompt,
                     String defaultValue)

Displays a prompt and waits for input.

Parameters:

prompt - the prompt to display

defaultValue - the default value to use, if no input is entered

Returns:

the user input value; if the user input is empty (return key pressed) return defaultValue

prompt

public String prompt(String prompt,
                     String[] values)

Prompts for a value from a set of values.

Parameters:

prompt - the prompt to display

values - the valid values

Returns:

the user input value; if the user input is empty (return key pressed) return defaultValue

prompt

public String prompt(String prompt,
                     String[] values,
                     String defaultValue)

Prompts for a value from a set of values.

Parameters:

prompt - the prompt to display

values - the valid values

defaultValue - the default value to return when the user input is empty

Returns:

the user input value; if the user input is empty (return key pressed) return defaultValue