public class GrailsConsole
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CATEGORY_SEPARATOR |
static java.lang.String |
ENABLE_INTERACTIVE |
static java.lang.String |
ENABLE_TERMINAL |
static java.lang.String |
ERROR |
static java.lang.String |
HISTORYFILE |
static java.lang.String |
LINE_SEPARATOR |
static java.lang.String |
PROMPT |
static java.lang.Character |
SECURE_MASK_CHAR |
static java.lang.String |
SPACE |
static java.lang.String |
STACKTRACE_FILTERED_MESSAGE |
static java.lang.String |
STACKTRACE_MESSAGE |
static java.lang.String |
WARNING |
| Modifier | Constructor and Description |
|---|---|
protected |
GrailsConsole() |
| Modifier and Type | Method and Description |
|---|---|
void |
addStatus(java.lang.String msg)
Keeps doesn't replace the status message
|
protected java.io.OutputStream |
ansiWrap(java.io.OutputStream out)
Hook method that allows controlling whether or not output streams should be wrapped by
AnsiConsole.wrapOutputStream.
|
void |
append(java.lang.String msg) |
void |
beforeShutdown() |
protected jline.console.ConsoleReader |
createConsoleReader() |
static GrailsConsole |
createInstance() |
protected jline.Terminal |
createTerminal()
Creates the instance of Terminal used directly in GrailsConsole.
|
void |
echoStatus()
Replays the last status message
|
void |
error(java.lang.String msg)
Prints an error message
|
void |
error(java.lang.String label,
java.lang.String message) |
void |
error(java.lang.String msg,
java.lang.Throwable error)
Use to log an error
|
void |
error(java.lang.Throwable error)
Use to log an error
|
void |
flush() |
java.util.Stack<java.lang.String> |
getCategory() |
java.io.PrintStream |
getErr() |
java.io.InputStream |
getInput() |
static GrailsConsole |
getInstance() |
java.lang.String |
getLastMessage() |
java.io.PrintStream |
getOut() |
jline.console.ConsoleReader |
getReader() |
jline.Terminal |
getTerminal() |
void |
indicateProgress()
Indicates progress with the default progress indicator
|
void |
indicateProgress(int number)
Indicates progress by number
|
void |
indicateProgress(int number,
int total)
Indicate progress for a number and total
|
void |
indicateProgressPercentage(long number,
long total)
Indicates progress as a percentage for the given number and total
|
void |
info(java.lang.String msg)
Synonym for #log
|
boolean |
isAnsiEnabled() |
boolean |
isInteractiveEnabled() |
boolean |
isStacktrace() |
boolean |
isVerbose() |
boolean |
isWindows() |
void |
log(java.lang.String msg)
Logs a message below the current status message
|
protected void |
persistHistory() |
protected jline.console.history.History |
prepareHistory()
Prepares a history file to be used by the ConsoleReader.
|
protected void |
restoreTerminal() |
java.lang.String |
secureUserInput(java.lang.String msg)
Like
userInput(String) except that the user's entered characters will be replaced with '*' on the CLI,
masking the input (i.e. |
void |
setAnsiEnabled(boolean ansiEnabled) |
void |
setErr(java.io.PrintStream err) |
static void |
setInstance(GrailsConsole newConsole) |
void |
setLastMessage(java.lang.String lastMessage) |
void |
setOut(java.io.PrintStream out) |
void |
setStacktrace(boolean stacktrace) |
void |
setVerbose(boolean verbose) |
java.lang.String |
showPrompt()
Shows the prompt to request user input
|
void |
updateStatus(java.lang.String msg)
Updates the current state message
|
java.lang.String |
userInput(java.lang.String msg)
Replacement for AntBuilder.input() to eliminate dependency of
GrailsScriptRunner on the Ant libraries.
|
java.lang.String |
userInput(java.lang.String message,
java.util.List<java.lang.String> validResponses) |
java.lang.String |
userInput(java.lang.String message,
java.lang.String[] validResponses)
Replacement for AntBuilder.input() to eliminate dependency of
GrailsScriptRunner on the Ant libraries.
|
void |
verbose(java.lang.String msg) |
void |
warn(java.lang.String msg)
Prints a warn message
|
void |
warning(java.lang.String msg)
Prints an error message
|
public static final java.lang.String ENABLE_TERMINAL
public static final java.lang.String ENABLE_INTERACTIVE
public static final java.lang.String LINE_SEPARATOR
public static final java.lang.String CATEGORY_SEPARATOR
public static final java.lang.String PROMPT
public static final java.lang.String SPACE
public static final java.lang.String ERROR
public static final java.lang.String WARNING
public static final java.lang.String HISTORYFILE
public static final java.lang.String STACKTRACE_FILTERED_MESSAGE
public static final java.lang.String STACKTRACE_MESSAGE
public static final java.lang.Character SECURE_MASK_CHAR
protected GrailsConsole()
throws java.io.IOException
java.io.IOExceptionpublic java.io.PrintStream getErr()
public void setErr(java.io.PrintStream err)
public void setOut(java.io.PrintStream out)
public boolean isInteractiveEnabled()
protected jline.console.ConsoleReader createConsoleReader()
throws java.io.IOException
java.io.IOExceptionprotected jline.Terminal createTerminal()
protected jline.console.history.History prepareHistory()
throws java.io.IOException
java.io.IOExceptionprotected java.io.OutputStream ansiWrap(java.io.OutputStream out)
public boolean isWindows()
public static GrailsConsole getInstance()
public void beforeShutdown()
protected void restoreTerminal()
protected void persistHistory()
public static void setInstance(GrailsConsole newConsole)
public static GrailsConsole createInstance() throws java.io.IOException
java.io.IOExceptionpublic void setAnsiEnabled(boolean ansiEnabled)
public void setVerbose(boolean verbose)
verbose - Sets whether verbose output should be usedpublic void setStacktrace(boolean stacktrace)
stacktrace - Sets whether to show stack traces on errorspublic boolean isVerbose()
public boolean isStacktrace()
public java.io.InputStream getInput()
public java.lang.String getLastMessage()
public void setLastMessage(java.lang.String lastMessage)
public jline.console.ConsoleReader getReader()
public jline.Terminal getTerminal()
public java.io.PrintStream getOut()
public java.util.Stack<java.lang.String> getCategory()
public void indicateProgress()
public void indicateProgress(int number,
int total)
number - The current numbertotal - The total numberpublic void indicateProgressPercentage(long number,
long total)
number - The numbertotal - The totalpublic void indicateProgress(int number)
number - The numberpublic void updateStatus(java.lang.String msg)
msg - The messagepublic void addStatus(java.lang.String msg)
msg - The messagepublic void error(java.lang.String msg)
msg - The error messagepublic void warning(java.lang.String msg)
msg - The error messagepublic void warn(java.lang.String msg)
msg - The messagepublic boolean isAnsiEnabled()
public void error(java.lang.String msg,
java.lang.Throwable error)
msg - The messageerror - The errorpublic void error(java.lang.Throwable error)
error - The errorpublic void log(java.lang.String msg)
msg - The message to logpublic void append(java.lang.String msg)
public void info(java.lang.String msg)
msg - The message to logpublic void verbose(java.lang.String msg)
public void echoStatus()
public java.lang.String userInput(java.lang.String msg)
msg - The message/question to display.public java.lang.String secureUserInput(java.lang.String msg)
userInput(String) except that the user's entered characters will be replaced with '*' on the CLI,
masking the input (i.e. suitable for capturing passwords etc.).msg - The message/question to display.public java.lang.String showPrompt()
public java.lang.String userInput(java.lang.String message,
java.util.List<java.lang.String> validResponses)
public java.lang.String userInput(java.lang.String message,
java.lang.String[] validResponses)
null.message - The message/question to display.validResponses - An array of responses that the user is
allowed to enter. Displayed after the message.null
if the user never entered a valid string.public void error(java.lang.String label,
java.lang.String message)
public void flush()