GrailsConsole (Grace Framework

grails.build.logging.GrailsConsole

All Implemented Interfaces and Traits:

ConsoleLogger
```
public class GrailsConsole
extends Object
implements ConsoleLogger
```
Utility class for delivering console output in a nicely formatted way.
Authors:
Graeme Rocher
Michael Yan
Since:
2.0

Field Summary

Fields
Modifiers	Name	Description
`static String`	`CATEGORY_SEPARATOR`
`static String`	`ENABLE_INTERACTIVE`
`static String`	`ENABLE_TERMINAL`
`static String`	`ERROR`
`static String`	`HISTORYFILE`
`static String`	`LINE_SEPARATOR`
`static String`	`PROMPT`
`static Character`	`SECURE_MASK_CHAR`
`static String`	`SPACE`
`static String`	`STACKTRACE_FILTERED_MESSAGE`
`static String`	`STACKTRACE_MESSAGE`
`static String`	`WARNING`

Constructor Summary

Constructors
Constructor and description
`protected GrailsConsole()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addShutdownHook()`
	`public void`	`addStatus(String msg)` Keeps doesn't replace the status message
	`public void`	`addStatus(String category, String msg)` Keeps doesn't replace the status message
	`public void`	`addStatus(String category, String msg, String color)` Keeps doesn't replace the status message
	`protected OutputStream`	`ansiWrap(OutputStream out)` Hook method that allows controlling whether or not output streams should be wrapped by AnsiConsole.wrapOutputStream.
	`public void`	`append(String msg)`
	`public void`	`beforeShutdown()`
	`protected void`	`bindSystemOutAndErr(PrintStream systemOut, PrintStream systemErr)`
	`public void`	`cleanlyExit(int status)`
	`protected jline.console.ConsoleReader`	`createConsoleReader(InputStream systemIn)`
	`public static GrailsConsole`	`createInstance()`
	`protected jline.Terminal`	`createTerminal()` Creates the instance of Terminal used directly in GrailsConsole.
	`public void`	`echoStatus()` Replays the last status message
	`public void`	`error(String msg)` Prints an error message
	`public void`	`error(String msg, Throwable error)` Use to log an error
	`public void`	`error(Throwable error)` Use to log an error
	`public void`	`error(String label, String message)`
	`public void`	`flush()` Makes sure that the console has been reset to the default state and that the out stream has been flushed.
	`public Stack<String>`	`getCategory()`
	`public Character`	`getDefaultInputMask()`
	`public PrintStream`	`getErr()`
	`public InputStream`	`getInput()` Returns: The input stream being read from
	`public static GrailsConsole`	`getInstance()`
	`public String`	`getLastMessage()` Returns: The last message logged
	`public PrintStream`	`getOut()`
	`public jline.console.ConsoleReader`	`getReader()`
	`public jline.Terminal`	`getTerminal()`
	`public void`	`indicateProgress()` Indicates progress with the default progress indicator
	`public void`	`indicateProgress(int number, int total)` Indicate progress for a number and total
	`public void`	`indicateProgress(int number)` Indicates progress by number
	`public void`	`indicateProgressPercentage(long number, long total)` Indicates progress as a percentage for the given number and total
	`public void`	`info(String msg)` Synonym for #log
	`protected void`	`initialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)`
	`public boolean`	`isAnsiEnabled()`
	`public boolean`	`isInteractiveEnabled()`
	`public boolean`	`isStacktrace()` Returns: Whether to show stack traces
	`public boolean`	`isVerbose()` Returns: Whether verbose output is being used
	`public boolean`	`isWindows()`
	`public void`	`log(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`	`redirectSystemOutAndErr(boolean force)`
	`public void`	`reinitialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)` Use in testing when System.out, System.err or System.in change
	`public static void`	`removeInstance()`
	`public void`	`removeShutdownHook()`
	`public void`	`resetCompleters()`
	`public void`	`restoreOriginalSystemOutAndErr()`
	`protected void`	`restoreTerminal()`
	`public String`	`secureUserInput(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.).
	`public void`	`setAnsiEnabled(boolean ansiEnabled)`
	`public void`	`setDefaultInputMask(Character defaultInputMask)`
	`public void`	`setErr(PrintStream err)`
	`public static void`	`setInstance(GrailsConsole newConsole)`
	`public void`	`setLastMessage(String lastMessage)`
	`public void`	`setOut(PrintStream out)`
	`public void`	`setStacktrace(boolean stacktrace)` Parameters: `stacktrace` - Sets whether to show stack traces on errors
	`public void`	`setVerbose(boolean verbose)` Parameters: `verbose` - Sets whether verbose output should be used
	`public String`	`showPrompt()` Shows the prompt to request user input
	`public String`	`toString()`
	`public void`	`updateStatus(String msg)` Updates the current state message
	`public String`	`userInput(String msg)` Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries.
	`public String`	`userInput(String message, List<String> validResponses)`
	`public String`	`userInput(String message, String[] validResponses)` Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries.
	`public void`	`verbose(String msg)`
	`public void`	`warn(String msg)` Prints a warn message
	`public void`	`warning(String msg)` Prints an error message

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final String CATEGORY_SEPARATOR
  - public static final String ENABLE_INTERACTIVE
  - public static final String ENABLE_TERMINAL
  - public static final String ERROR
  - public static final String HISTORYFILE
  - public static final String LINE_SEPARATOR
  - public static final String PROMPT
  - public static final Character SECURE_MASK_CHAR
  - public static final String SPACE
  - public static final String STACKTRACE_FILTERED_MESSAGE
  - public static final String STACKTRACE_MESSAGE
  - public static final String WARNING
- Constructor Detail
  - protected GrailsConsole()
- Method Detail
  - public void addShutdownHook()
  - @Override
    public void addStatus(String msg)
    
    Keeps doesn't replace the status message
    Parameters:
    msg - The message
  - public void addStatus(String category, String msg)
    
    Keeps doesn't replace the status message
    Parameters:
    category - The category
    msg - The message
  - public void addStatus(String category, String msg, String color)
    
    Keeps doesn't replace the status message
    Parameters:
    category - The category
    msg - The message
    color - The color
  - protected OutputStream ansiWrap(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).
  - public void append(String msg)
  - public void beforeShutdown()
  - protected void bindSystemOutAndErr(PrintStream systemOut, PrintStream systemErr)
  - public void cleanlyExit(int status)
  - protected jline.console.ConsoleReader createConsoleReader(InputStream systemIn)
  - @SuppressWarnings("unchecked")
    public static GrailsConsole createInstance()
  - 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.
  - public void echoStatus()
    
    Replays the last status message
  - @Override
    public void error(String msg)
    
    Prints an error message
    Parameters:
    msg - The error message
  - @Override
    public void error(String msg, Throwable error)
    
    Use to log an error
    Parameters:
    msg - The message
    error - The error
  - @Override
    public void error(Throwable error)
    
    Use to log an error
    Parameters:
    error - The error
  - @Override
    public void error(String label, String message)
  - public void flush()
    
    Makes sure that the console has been reset to the default state and that the out stream has been flushed.
  - public Stack<String> getCategory()
  - public Character getDefaultInputMask()
  - public PrintStream getErr()
  - public InputStream getInput()
    
    Returns:
    The input stream being read from
  - public static GrailsConsole getInstance()
  - public String getLastMessage()
    
    Returns:
    The last message logged
  - public PrintStream getOut()
  - public jline.console.ConsoleReader getReader()
  - public jline.Terminal getTerminal()
  - @Override
    public void indicateProgress()
    
    Indicates progress with the default progress indicator
  - @Override
    public void indicateProgress(int number, int total)
    
    Indicate progress for a number and total
    Parameters:
    number - The current number
    total - The total number
  - @Override
    public void indicateProgress(int number)
    
    Indicates progress by number
    Parameters:
    number - The number
  - @Override
    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
  - @Override
    public void info(String msg)
    
    Synonym for #log
    Parameters:
    msg - The message to log
  - protected void initialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)
  - public boolean isAnsiEnabled()
  - public boolean isInteractiveEnabled()
  - public boolean isStacktrace()
    
    Returns:
    Whether to show stack traces
  - public boolean isVerbose()
    
    Returns:
    Whether verbose output is being used
  - public boolean isWindows()
  - @Override
    public void log(String msg)
    
    Logs a message below the current status message
    Parameters:
    msg - The message to log
  - protected void persistHistory()
  - protected jline.console.history.History prepareHistory()
    
    Prepares a history file to be used by the ConsoleReader. This file will live in the home directory of the user.
  - protected void redirectSystemOutAndErr(boolean force)
  - public void reinitialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)
    
    Use in testing when System.out, System.err or System.in change
    throws:
    IOException
  - public static void removeInstance()
  - public void removeShutdownHook()
  - public void resetCompleters()
  - public void restoreOriginalSystemOutAndErr()
  - protected void restoreTerminal()
  - public String secureUserInput(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.
  - public void setAnsiEnabled(boolean ansiEnabled)
  - public void setDefaultInputMask(Character defaultInputMask)
  - public void setErr(PrintStream err)
  - public static void setInstance(GrailsConsole newConsole)
  - public void setLastMessage(String lastMessage)
  - public void setOut(PrintStream out)
  - public void setStacktrace(boolean stacktrace)
    
    Parameters:
    stacktrace - Sets whether to show stack traces on errors
  - public void setVerbose(boolean verbose)
    
    Parameters:
    verbose - Sets whether verbose output should be used
  - public String showPrompt()
    
    Shows the prompt to request user input
    Returns:
    The user input prompt
  - @Override
    public String toString()
  - @Override
    public void updateStatus(String msg)
    
    Updates the current state message
    Parameters:
    msg - The message
  - public String userInput(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.
  - public String userInput(String message, List<String> validResponses)
  - public String userInput(String message, 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.
  - @Override
    public void verbose(String msg)
  - @Override
    public void warn(String msg)
    
    Prints a warn message
    Parameters:
    msg - The message
  - @Override
    public void warning(String msg)
    
    Prints an error message
    Parameters:
    msg - The error message

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class GrailsConsole

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final String CATEGORY_SEPARATOR

public static final String ENABLE_INTERACTIVE

public static final String ENABLE_TERMINAL

public static final String ERROR

public static final String HISTORYFILE

public static final String LINE_SEPARATOR

public static final String PROMPT

public static final Character SECURE_MASK_CHAR

public static final String SPACE

public static final String STACKTRACE_FILTERED_MESSAGE

public static final String STACKTRACE_MESSAGE

public static final String WARNING

Constructor Detail

protected GrailsConsole()

Method Detail

public void addShutdownHook()

@Overridepublic void addStatus(String msg)

public void addStatus(String category, String msg)

public void addStatus(String category, String msg, String color)

protected OutputStream ansiWrap(OutputStream out)

public void append(String msg)

public void beforeShutdown()

protected void bindSystemOutAndErr(PrintStream systemOut, PrintStream systemErr)

public void cleanlyExit(int status)

protected jline.console.ConsoleReader createConsoleReader(InputStream systemIn)

@SuppressWarnings("unchecked")public static GrailsConsole createInstance()

protected jline.Terminal createTerminal()

public void echoStatus()

@Overridepublic void error(String msg)

@Overridepublic void error(String msg, Throwable error)

@Overridepublic void error(Throwable error)

@Overridepublic void error(String label, String message)

public void flush()

public Stack<String> getCategory()

public Character getDefaultInputMask()

public PrintStream getErr()

public InputStream getInput()

public static GrailsConsole getInstance()

public String getLastMessage()

public PrintStream getOut()

public jline.console.ConsoleReader getReader()

public jline.Terminal getTerminal()

@Overridepublic void indicateProgress()

@Overridepublic void indicateProgress(int number, int total)

@Overridepublic void indicateProgress(int number)

@Overridepublic void indicateProgressPercentage(long number, long total)

@Overridepublic void info(String msg)

protected void initialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)

public boolean isAnsiEnabled()

public boolean isInteractiveEnabled()

public boolean isStacktrace()

public boolean isVerbose()

public boolean isWindows()

@Overridepublic void log(String msg)

protected void persistHistory()

protected jline.console.history.History prepareHistory()

protected void redirectSystemOutAndErr(boolean force)

public void reinitialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)

public static void removeInstance()

public void removeShutdownHook()

public void resetCompleters()

public void restoreOriginalSystemOutAndErr()

protected void restoreTerminal()

public String secureUserInput(String msg)

public void setAnsiEnabled(boolean ansiEnabled)

public void setDefaultInputMask(Character defaultInputMask)

public void setErr(PrintStream err)

public static void setInstance(GrailsConsole newConsole)

public void setLastMessage(String lastMessage)

public void setOut(PrintStream out)

public void setStacktrace(boolean stacktrace)

public void setVerbose(boolean verbose)

public String showPrompt()

@Overridepublic String toString()

@Override
public void addStatus(String msg)

@SuppressWarnings("unchecked")
public static GrailsConsole createInstance()

@Override
public void error(String msg)

@Override
public void error(String msg, Throwable error)

@Override
public void error(Throwable error)

@Override
public void error(String label, String message)

@Override
public void indicateProgress()

@Override
public void indicateProgress(int number, int total)

@Override
public void indicateProgress(int number)

@Override
public void indicateProgressPercentage(long number, long total)

@Override
public void info(String msg)

@Override
public void log(String msg)

@Override
public String toString()

@Override
public void updateStatus(String msg)

@Override
public void verbose(String msg)

@Override
public void warn(String msg)

@Override
public void warning(String msg)