Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

grails.build.logging
[Java] Class GrailsConsole

java.lang.Object
  grails.build.logging.GrailsConsole

public class GrailsConsole
extends java.lang.Object

Utility class for delivering console output in a nicely formatted way.

Authors:
Graeme Rocher
Since:
2.0

Field Summary
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

 
Constructor Summary
protected GrailsConsole()

 
Method Summary
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.

protected jline.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 msg, java.lang.Throwable error)

Use to log an error
void error(java.lang.Throwable error)

Use to log an error
void error(java.lang.String label, java.lang.String message)

void flush()

java.util.Stack getCategory()

java.io.InputStream getInput()

@return The input stream being read from
static GrailsConsole getInstance()

java.lang.String getLastMessage()

@return The last message logged
java.io.PrintStream getOut()

jline.ConsoleReader getReader()

jline.Terminal getTerminal()

void indicateProgress()

Indicates progress with the default progress indicator
void indicateProgress(int number, int total)

Indicate progress for a number and total
void indicateProgress(int number)

Indicates progress by number
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 isVerbose()

@return Whether verbose output is being used
void log(java.lang.String msg)

Logs a message below the current status message
protected jline.History prepareHistory()

Prepares a history file to be used by the ConsoleReader.

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. suitable for capturing passwords etc.).
void setAnsiEnabled(boolean ansiEnabled)

void setLastMessage(java.lang.String lastMessage)

void setStacktrace(boolean stacktrace)

@param stacktrace Sets whether to show stack traces on errors
void setVerbose(boolean verbose)

@param verbose Sets whether verbose output should be used
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.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
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Field Detail

CATEGORY_SEPARATOR

public static final java.lang.String CATEGORY_SEPARATOR

ENABLE_INTERACTIVE

public static final java.lang.String ENABLE_INTERACTIVE

ENABLE_TERMINAL

public static final java.lang.String ENABLE_TERMINAL

ERROR

public static final java.lang.String ERROR

HISTORYFILE

public static final java.lang.String HISTORYFILE

LINE_SEPARATOR

public static final java.lang.String LINE_SEPARATOR

PROMPT

public static final java.lang.String PROMPT

SECURE_MASK_CHAR

public static final java.lang.Character SECURE_MASK_CHAR

SPACE

public static final java.lang.String SPACE

STACKTRACE_FILTERED_MESSAGE

public static final java.lang.String STACKTRACE_FILTERED_MESSAGE

STACKTRACE_MESSAGE

public static final java.lang.String STACKTRACE_MESSAGE

WARNING

public static final java.lang.String WARNING

 
Constructor Detail

GrailsConsole

protected GrailsConsole()

 
Method Detail

addStatus

public void addStatus(java.lang.String msg)
Keeps doesn't replace the status message
Parameters:
msg - The message

ansiWrap

protected java.io.OutputStream ansiWrap(@SuppressWarnings("hiding") java.io.OutputStream out)
Hook method that allows controlling whether or not output streams should be wrapped by AnsiConsole.wrapOutputStream. Unfortunately, Eclipse consoles will look to the AnsiWrap like they do not understand ansi, even if we were to implement support in Eclipse to' handle it and the wrapped stream will not pass the ansi chars on to Eclipse).

createConsoleReader

protected jline.ConsoleReader createConsoleReader()

createInstance

public static GrailsConsole createInstance()

createTerminal

protected jline.Terminal createTerminal()
Creates the instance of Terminal used directly in GrailsConsole. Note that there is also another terminal instance created implicitly inside of ConsoleReader. That instance is controlled by the jline.terminal system property.

echoStatus

public void echoStatus()
Replays the last status message

error

public void error(java.lang.String msg)
Prints an error message
Parameters:
msg - The error message

error

public void error(java.lang.String msg, java.lang.Throwable error)
Use to log an error
Parameters:
msg - The message
error - The error

error

public void error(java.lang.Throwable error)
Use to log an error
Parameters:
error - The error

error

public void error(java.lang.String label, java.lang.String message)

flush

public void flush()

getCategory

public java.util.Stack getCategory()

getInput

public java.io.InputStream getInput()
Returns:
The input stream being read from

getInstance

public static GrailsConsole getInstance()

getLastMessage

public java.lang.String getLastMessage()
Returns:
The last message logged

getOut

public java.io.PrintStream getOut()

getReader

public jline.ConsoleReader getReader()

getTerminal

public jline.Terminal getTerminal()

indicateProgress

public void indicateProgress()
Indicates progress with the default progress indicator

indicateProgress

public void indicateProgress(int number, int total)
Indicate progress for a number and total
Parameters:
number - The current number
total - The total number

indicateProgress

public void indicateProgress(int number)
Indicates progress by number
Parameters:
number - The number

indicateProgressPercentage

public void indicateProgressPercentage(long number, long total)
Indicates progress as a percentage for the given number and total
Parameters:
number - The number
total - The total

info

public void info(java.lang.String msg)
Synonym for #log
Parameters:
msg - The message to log

isAnsiEnabled

public boolean isAnsiEnabled()

isVerbose

public boolean isVerbose()
Returns:
Whether verbose output is being used

log

public void log(java.lang.String msg)
Logs a message below the current status message
Parameters:
msg - The message to log

prepareHistory

protected jline.History prepareHistory()
Prepares a history file to be used by the ConsoleReader. This file will live in the home directory of the user.

secureUserInput

public 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. suitable for capturing passwords etc.).
Parameters:
msg - The message/question to display.
Returns:
The line of text entered by the user. May be a blank string.

setAnsiEnabled

public void setAnsiEnabled(boolean ansiEnabled)

setLastMessage

public void setLastMessage(java.lang.String lastMessage)

setStacktrace

public void setStacktrace(boolean stacktrace)
Parameters:
stacktrace - Sets whether to show stack traces on errors

setVerbose

public void setVerbose(boolean verbose)
Parameters:
verbose - Sets whether verbose output should be used

showPrompt

public java.lang.String showPrompt()
Shows the prompt to request user input
Returns:
The user input prompt

updateStatus

public void updateStatus(java.lang.String msg)
Updates the current state message
Parameters:
msg - The message

userInput

public java.lang.String userInput(java.lang.String msg)
Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries. Prints a message and returns whatever the user enters (once they press <return>).
Parameters:
msg - The message/question to display.
Returns:
The line of text entered by the user. May be a blank string.

userInput

public 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. Prints a message and list of valid responses, then returns whatever the user enters (once they press <return>). If the user enters something that is not in the array of valid responses, the message is displayed again and the method waits for more input. It will display the message a maximum of three times before it gives up and returns null.
Parameters:
message - The message/question to display.
validResponses - An array of responses that the user is allowed to enter. Displayed after the message.
Returns:
The line of text entered by the user, or null if the user never entered a valid string.

verbose

public void verbose(java.lang.String msg)

warn

public void warn(java.lang.String msg)
Prints a warn message
Parameters:
msg - The message

warning

public void warning(java.lang.String msg)
Prints an error message
Parameters:
msg - The error message

 

Groovy Documentation