com.google.gerrit.pgm.init.api

Class ConsoleUI

java.lang.Object

com.google.gerrit.pgm.init.api.ConsoleUI

public abstract class ConsoleUI
extends Object

Console based interaction with the invoking user.

Constructor Summary

Constructors

Constructor and Description
ConsoleUI()

Method Summary

Modifier and Type	Method and Description
protected static Die	abort() Constructs an exception indicating the user aborted the operation.
void	error(String format, Object... args) Display an error message on the system stderr.
static ConsoleUI	getInstance() Get a UI instance, assuming interactive mode.
static ConsoleUI	getInstance(boolean batchMode) Get a UI instance, possibly forcing batch mode.
abstract void	header(String fmt, Object... args) Display a header message before a series of prompts.
abstract boolean	isBatch()
abstract void	message(String fmt, Object... args) Display a message.
abstract String	password(String fmt, Object... args) Prompt the user for a password, returning the string; null if blank.
abstract <T extends Enum<?>,A extends EnumSet<? extends T>> T	readEnum(T def, A options, String fmt, Object... args) Prompt the user to make a choice from an enumeration's values.
int	readInt(int def, String fmt, Object... args) Prompt the user for an integer value, suggesting a default.
abstract String	readString(String def, Set<String> allowedValues, String fmt, Object... args) Prompt the user to make a choice from an allowed list of values.
abstract String	readString(String def, String fmt, Object... args) Prompt the user for a string, suggesting a default, and returning choice.
abstract void	waitForUser() Prints a message asking the user to let us know when its safe to continue.
abstract boolean	yesno(Boolean def, String fmt, Object... args) Request the user to answer a yes/no question.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleUI

public ConsoleUI()

Method Detail

getInstance

public static ConsoleUI getInstance()

Get a UI instance, assuming interactive mode.

getInstance

public static ConsoleUI getInstance(boolean batchMode)

Get a UI instance, possibly forcing batch mode.

abort

protected static Die abort()

Constructs an exception indicating the user aborted the operation.

isBatch

public abstract boolean isBatch()

Returns:

true if this is a batch UI that has no user interaction.

header

public abstract void header(String fmt,
                            Object... args)

Display a header message before a series of prompts.

message

public abstract void message(String fmt,
                             Object... args)

Display a message.

yesno

public abstract boolean yesno(Boolean def,
                              String fmt,
                              Object... args)

Request the user to answer a yes/no question.

waitForUser

public abstract void waitForUser()

Prints a message asking the user to let us know when its safe to continue.

readString

public abstract String readString(String def,
                                  String fmt,
                                  Object... args)

Prompt the user for a string, suggesting a default, and returning choice.

readString

public abstract String readString(String def,
                                  Set<String> allowedValues,
                                  String fmt,
                                  Object... args)

Prompt the user to make a choice from an allowed list of values.

readInt

public int readInt(int def,
                   String fmt,
                   Object... args)

Prompt the user for an integer value, suggesting a default.

password

public abstract String password(String fmt,
                                Object... args)

Prompt the user for a password, returning the string; null if blank.

error

public void error(String format,
                  Object... args)

Display an error message on the system stderr.

readEnum

public abstract <T extends Enum<?>,A extends EnumSet<? extends T>> T readEnum(T def,
                                                                              A options,
                                                                              String fmt,
                                                                              Object... args)

Prompt the user to make a choice from an enumeration's values.