MicronautConsole (micronaut 1.2.5 API)

java.lang.Object
- io.micronaut.cli.console.logging.MicronautConsole

All Implemented Interfaces:

ConsoleLogger
```
public class MicronautConsole
extends Object
implements ConsoleLogger
```
Utility class for delivering console output in a nicely formatted way.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields
Modifier and Type	Field and 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
Modifier Constructor and Description

protected MicronautConsole()
Default constructor for the Micronaut console.

Constructors
Modifier	Constructor and Description
`protected`	`MicronautConsole()` Default constructor for the Micronaut console.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addShutdownHook()` Add a shutdown hook.
`void`	`addStatus(String msg)` 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.
`void`	`append(String msg)` Append a message.
`void`	`beforeShutdown()` Execute before shutdown the console.
`protected void`	`bindSystemOutAndErr(PrintStream systemOut, PrintStream systemErr)`
`void`	`cleanlyExit(int status)` Flush before exit.
`protected jline.console.ConsoleReader`	`createConsoleReader(InputStream systemIn)` Create a console reader.
`static MicronautConsole`	`createInstance()` Create a new Micronaut console instance.
`protected jline.Terminal`	`createTerminal()` Creates the instance of Terminal used directly in MicronautConsole.
`void`	`echoStatus()` Replays the last status message.
`void`	`error(String msg)` Prints an error message.
`void`	`error(String label, String message)` Log an error with a specific error label.
`void`	`error(String msg, Throwable error)` Use to log an error.
`void`	`error(Throwable error)` Use to log an error.
`void`	`flush()` Makes sure that the console has been reset to the default state and that the out stream has been flushed.
`Stack<String>`	`getCategory()`
`Character`	`getDefaultInputMask()`
`PrintStream`	`getErr()`
`InputStream`	`getInput()`
`static MicronautConsole`	`getInstance()`
`String`	`getLastMessage()`
`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(String msg)` Synonym for #log.
`protected void`	`initialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)`
`boolean`	`isAnsiEnabled()`
`boolean`	`isInteractiveEnabled()`
`boolean`	`isStacktrace()`
`boolean`	`isVerbose()`
`boolean`	`isWindows()`
`void`	`log(String msg)` Logs a message below the current status message.
`protected void`	`persistHistory()` Persist the history.
`protected jline.console.history.History`	`prepareHistory()` Prepares a history file to be used by the ConsoleReader.
`protected void`	`redirectSystemOutAndErr(boolean force)` Redirect system out and error to the console.
`void`	`reinitialize(InputStream systemIn, PrintStream systemOut, PrintStream systemErr)` Use in testing when System.out, System.err or System.in change.
`static void`	`removeInstance()` Remove the Micronaut console.
`void`	`removeShutdownHook()` Remove a shutdown hook.
`void`	`resetCompleters()` Reset the completers.
`void`	`restoreOriginalSystemOutAndErr()` Restore the original system output and error.
`protected void`	`restoreTerminal()` Restore the terminal.
`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.
`void`	`setAnsiEnabled(boolean ansiEnabled)`
`void`	`setDefaultInputMask(Character defaultInputMask)` Set the default input mask.
`void`	`setErr(PrintStream err)` Sets the err stream.
`static void`	`setInstance(MicronautConsole newConsole)`
`void`	`setLastMessage(String lastMessage)` Sets the last message logged.
`void`	`setOut(PrintStream out)` Sets the out stream.
`void`	`setStacktrace(boolean stacktrace)`
`void`	`setVerbose(boolean verbose)`
`String`	`showPrompt()` Shows the prompt to request user input.
`void`	`updateStatus(String msg)` Updates the current state message.
`String`	`userInput(String msg)` Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries.
`String`	`userInput(String message, List<String> validResponses)`
`String`	`userInput(String message, String[] validResponses)` Replacement for AntBuilder.input() to eliminate dependency of GrailsScriptRunner on the Ant libraries.
`void`	`verbose(String msg)` Outputs a verbose message.
`void`	`warn(String msg)` Prints a warn message.
`void`	`warning(String msg)` Prints an error message.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENABLE_TERMINAL
```
public static final String ENABLE_TERMINAL
```
    See Also:
    
    Constant Field Values
  - ENABLE_INTERACTIVE
```
public static final String ENABLE_INTERACTIVE
```
    See Also:
    
    Constant Field Values
  - LINE_SEPARATOR
```
public static final String LINE_SEPARATOR
```
  - CATEGORY_SEPARATOR
```
public static final String CATEGORY_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - PROMPT
```
public static final String PROMPT
```
    See Also:
    
    Constant Field Values
  - SPACE
```
public static final String SPACE
```
    See Also:
    
    Constant Field Values
  - ERROR
```
public static final String ERROR
```
    See Also:
    
    Constant Field Values
  - WARNING
```
public static final String WARNING
```
    See Also:
    
    Constant Field Values
  - HISTORYFILE
```
public static final String HISTORYFILE
```
    See Also:
    
    Constant Field Values
  - STACKTRACE_FILTERED_MESSAGE
```
public static final String STACKTRACE_FILTERED_MESSAGE
```
    See Also:
    
    Constant Field Values
  - STACKTRACE_MESSAGE
```
public static final String STACKTRACE_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SECURE_MASK_CHAR
```
public static final Character SECURE_MASK_CHAR
```
- Constructor Detail
  - MicronautConsole
```
protected MicronautConsole()
                    throws IOException
```
    Default constructor for the Micronaut console.
    
    Throws:
    
    IOException - if there is an error
- Method Detail
  - addShutdownHook
```
public void addShutdownHook()
```
    Add a shutdown hook.
  - removeShutdownHook
```
public void removeShutdownHook()
```
    Remove a shutdown hook.
  - reinitialize
```
public void reinitialize(InputStream systemIn,
                         PrintStream systemOut,
                         PrintStream systemErr)
                  throws IOException
```
    Use in testing when System.out, System.err or System.in change.
    
    Parameters:
    
    systemIn - The system in
    
    systemOut - The system out
    
    systemErr - The system err
    
    Throws:
    
    IOException - if there is an error
  - initialize
```
protected void initialize(InputStream systemIn,
                          PrintStream systemOut,
                          PrintStream systemErr)
                   throws IOException
```
    Parameters:
    
    systemIn - The system in
    
    systemOut - The system out
    
    systemErr - The system err
    
    Throws:
    
    IOException - if there is an error
  - bindSystemOutAndErr
```
protected void bindSystemOutAndErr(PrintStream systemOut,
                                   PrintStream systemErr)
```
    Parameters:
    
    systemOut - The system out
    
    systemErr - The system error
  - getErr
```
public PrintStream getErr()
```
    Returns:
    
    The err stream
  - setErr
```
public void setErr(PrintStream err)
```
    Sets the err stream.
    
    Parameters:
    
    err - The err print stream
  - setOut
```
public void setOut(PrintStream out)
```
    Sets the out stream.
    
    Parameters:
    
    out - The out print stream
  - isInteractiveEnabled
```
public boolean isInteractiveEnabled()
```
    Returns:
    
    Whether interactive mode is enabled
  - createConsoleReader
```
protected jline.console.ConsoleReader createConsoleReader(InputStream systemIn)
                                                   throws IOException
```
    Create a console reader.
    
    Parameters:
    
    systemIn - The input stream
    
    Returns:
    
    The console reader
    
    Throws:
    
    IOException - if there is an error
  - createTerminal
```
protected jline.Terminal createTerminal()
```
    Creates the instance of Terminal used directly in MicronautConsole. Note that there is also another terminal instance created implicitly inside of ConsoleReader. That instance is controlled by the jline.terminal system property.
    
    Returns:
    
    the new Terminal
  - resetCompleters
```
public void resetCompleters()
```
    Reset the completers.
  - prepareHistory
```
protected jline.console.history.History prepareHistory()
                                                throws IOException
```
    Prepares a history file to be used by the ConsoleReader. This file will live in the home directory of the user.
    
    Returns:
    
    The History
    
    Throws:
    
    IOException - if there is an error
  - ansiWrap
```
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).
    
    Parameters:
    
    out - The output stream
    
    Returns:
    
    The output stream wrapped an as AnsiConsole
  - isWindows
```
public boolean isWindows()
```
    Returns:
    
    Whether is Windows OS
  - getInstance
```
public static MicronautConsole getInstance()
```
    Returns:
    
    The Micronaut console
  - removeInstance
```
public static void removeInstance()
```
    Remove the Micronaut console.
  - beforeShutdown
```
public void beforeShutdown()
```
    Execute before shutdown the console.
  - restoreTerminal
```
protected void restoreTerminal()
```
    Restore the terminal.
  - persistHistory
```
protected void persistHistory()
```
    Persist the history.
  - setInstance
```
public static void setInstance(MicronautConsole newConsole)
```
    Parameters:
    
    newConsole - The new Micronaut console
  - redirectSystemOutAndErr
```
protected void redirectSystemOutAndErr(boolean force)
```
    Redirect system out and error to the console.
    
    Parameters:
    
    force - Whether to force the redirect
  - createInstance
```
public static MicronautConsole createInstance()
                                       throws IOException
```
    Create a new Micronaut console instance.
    
    Returns:
    
    The Micronaut console
    
    Throws:
    
    IOException - if there is an error
  - setAnsiEnabled
```
public void setAnsiEnabled(boolean ansiEnabled)
```
    Parameters:
    
    ansiEnabled - Whether to enable ansi support
  - setVerbose
```
public void setVerbose(boolean verbose)
```
    Parameters:
    
    verbose - Sets whether verbose output should be used
  - setStacktrace
```
public void setStacktrace(boolean stacktrace)
```
    Parameters:
    
    stacktrace - Sets whether to show stack traces on errors
  - isVerbose
```
public boolean isVerbose()
```
    Returns:
    
    Whether verbose output is being used
  - isStacktrace
```
public boolean isStacktrace()
```
    Returns:
    
    Whether to show stack traces
  - getInput
```
public InputStream getInput()
```
    Returns:
    
    The input stream being read from
  - getLastMessage
```
public String getLastMessage()
```
    Returns:
    
    The last message logged
  - setLastMessage
```
public void setLastMessage(String lastMessage)
```
    Sets the last message logged.
    
    Parameters:
    
    lastMessage - The last message logged
  - getReader
```
public jline.console.ConsoleReader getReader()
```
    Returns:
    
    The console reader
  - getTerminal
```
public jline.Terminal getTerminal()
```
    Returns:
    
    The terminal
  - getOut
```
public PrintStream getOut()
```
    Returns:
    
    The output stream
  - getCategory
```
public Stack<String> getCategory()
```
    Returns:
    
    The category
  - indicateProgress
```
public void indicateProgress()
```
    Indicates progress with the default progress indicator.
    
    Specified by:
    
    indicateProgress in interface ConsoleLogger
  - indicateProgress
```
public void indicateProgress(int number,
                             int total)
```
    Indicate progress for a number and total.
    
    Specified by:
    
    indicateProgress in interface ConsoleLogger
    
    Parameters:
    
    number - The current number
    
    total - The total number
  - indicateProgressPercentage
```
public void indicateProgressPercentage(long number,
                                       long total)
```
    Indicates progress as a percentage for the given number and total.
    
    Specified by:
    
    indicateProgressPercentage in interface ConsoleLogger
    
    Parameters:
    
    number - The number
    
    total - The total
  - indicateProgress
```
public void indicateProgress(int number)
```
    Indicates progress by number.
    
    Specified by:
    
    indicateProgress in interface ConsoleLogger
    
    Parameters:
    
    number - The number
  - updateStatus
```
public void updateStatus(String msg)
```
    Updates the current state message.
    
    Specified by:
    
    updateStatus in interface ConsoleLogger
    
    Parameters:
    
    msg - The message
  - addStatus
```
public void addStatus(String msg)
```
    Keeps doesn't replace the status message.
    
    Specified by:
    
    addStatus in interface ConsoleLogger
    
    Parameters:
    
    msg - The message
  - error
```
public void error(String msg)
```
    Prints an error message.
    
    Specified by:
    
    error in interface ConsoleLogger
    
    Parameters:
    
    msg - The error message
  - warning
```
public void warning(String msg)
```
    Prints an error message.
    
    Specified by:
    
    warning in interface ConsoleLogger
    
    Parameters:
    
    msg - The error message
  - warn
```
public void warn(String msg)
```
    Prints a warn message.
    
    Specified by:
    
    warn in interface ConsoleLogger
    
    Parameters:
    
    msg - The message
  - isAnsiEnabled
```
public boolean isAnsiEnabled()
```
    Returns:
    
    Whether ansi is enabled
  - error
```
public void error(String msg,
                  Throwable error)
```
    Use to log an error.
    
    Specified by:
    
    error in interface ConsoleLogger
    
    Parameters:
    
    msg - The message
    
    error - The error
  - error
```
public void error(Throwable error)
```
    Use to log an error.
    
    Specified by:
    
    error in interface ConsoleLogger
    
    Parameters:
    
    error - The error
  - log
```
public void log(String msg)
```
    Logs a message below the current status message.
    
    Specified by:
    
    log in interface ConsoleLogger
    
    Parameters:
    
    msg - The message to log
  - append
```
public void append(String msg)
```
    Append a message.
    
    Parameters:
    
    msg - The message
  - info
```
public void info(String msg)
```
    Synonym for #log.
    
    Specified by:
    
    info in interface ConsoleLogger
    
    Parameters:
    
    msg - The message to log
  - verbose
```
public void verbose(String msg)
```
    Description copied from interface: ConsoleLogger
    
    Outputs a verbose message.
    
    Specified by:
    
    verbose in interface ConsoleLogger
    
    Parameters:
    
    msg - The message
  - echoStatus
```
public void echoStatus()
```
    Replays the last status message.
  - userInput
```
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.
  - secureUserInput
```
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.
  - showPrompt
```
public String showPrompt()
```
    Shows the prompt to request user input.
    
    Returns:
    
    The user input prompt
  - userInput
```
public String userInput(String message,
                        List<String> validResponses)
```
    Parameters:
    
    message - The message
    
    validResponses - The valid response
    
    Returns:
    
    The line of text entered by the user
  - userInput
```
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.
  - error
```
public void error(String label,
                  String message)
```
    Description copied from interface: ConsoleLogger
    
    Log an error with a specific error label.
    
    Specified by:
    
    error in interface ConsoleLogger
    
    Parameters:
    
    label - The label
    
    message - The message
  - restoreOriginalSystemOutAndErr
```
public void restoreOriginalSystemOutAndErr()
```
    Restore the original system output and error.
  - cleanlyExit
```
public void cleanlyExit(int status)
```
    Flush before exit.
    
    Parameters:
    
    status - The exit status
  - flush
```
public void flush()
```
    Makes sure that the console has been reset to the default state and that the out stream has been flushed.
  - getDefaultInputMask
```
public Character getDefaultInputMask()
```
    Returns:
    
    The default input mask
  - setDefaultInputMask
```
public void setDefaultInputMask(Character defaultInputMask)
```
    Set the default input mask.
    
    Parameters:
    
    defaultInputMask - The default input mask

Class MicronautConsole

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENABLE_TERMINAL

ENABLE_INTERACTIVE

LINE_SEPARATOR

CATEGORY_SEPARATOR

PROMPT

SPACE

ERROR

WARNING

HISTORYFILE

STACKTRACE_FILTERED_MESSAGE

STACKTRACE_MESSAGE

SECURE_MASK_CHAR

Constructor Detail

MicronautConsole

Method Detail

addShutdownHook

removeShutdownHook

reinitialize

initialize

bindSystemOutAndErr

getErr

setErr

setOut

isInteractiveEnabled

createConsoleReader

createTerminal

resetCompleters

prepareHistory

ansiWrap

isWindows

getInstance

removeInstance

beforeShutdown

restoreTerminal

persistHistory

setInstance

redirectSystemOutAndErr

createInstance

setAnsiEnabled

setVerbose

setStacktrace

isVerbose

isStacktrace

getInput

getLastMessage

setLastMessage

getReader

getTerminal

getOut

getCategory

indicateProgress

indicateProgress

indicateProgressPercentage

indicateProgress

updateStatus

addStatus

error

warning

warn

isAnsiEnabled

error

error

log

append

info

verbose

echoStatus

userInput

secureUserInput

showPrompt

userInput

userInput

error

restoreOriginalSystemOutAndErr