com.facebook.buck.util

Class Console

java.lang.Object

com.facebook.buck.util.Console

Direct Known Subclasses:

DuplicatingConsole

public class Console
extends Object

Constructor Summary

Constructors

Constructor and Description
Console(Verbosity verbosity, PrintStream stdOut, PrintStream stdErr, Ansi ansi)

Method Summary

Modifier and Type	Method and Description
static Console	createNullConsole() Returns a Console that simply discards written bytes.
Ansi	getAnsi()
DirtyPrintStreamDecorator	getStdErr()
DirtyPrintStreamDecorator	getStdOut()
Verbosity	getVerbosity()
void	printBuildFailure(String failureMessage) Prints an error message prefixed with BUILD FAILED to stderr that will be highlighted in red if stderr is a tty.
void	printErrorText(String message) Prints an error message to stderr that will be highlighted in red if stderr is a tty.
void	printErrorText(String message, Object... args) Prints a formatted error message.
void	printFailure(String failureMessage) Prints error message to console in red, also logs stacktrace but does not display it
void	printSuccess(String successMessage)
void	printSuccess(String successMessage, Object... args) Prints a formatted success message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Console

public Console(Verbosity verbosity,
               PrintStream stdOut,
               PrintStream stdErr,
               Ansi ansi)

Method Detail

createNullConsole

public static Console createNullConsole()

Returns a Console that simply discards written bytes.

getVerbosity

public Verbosity getVerbosity()

getAnsi

public Ansi getAnsi()

getStdOut

public DirtyPrintStreamDecorator getStdOut()

getStdErr

public DirtyPrintStreamDecorator getStdErr()

printSuccess

public void printSuccess(String successMessage)

Parameters:

successMessage - single line of text without a trailing newline. If stdErr is attached to a terminal, then this will append an ANSI reset escape sequence followed by a newline.

printSuccess

public void printSuccess(String successMessage,
                         Object... args)

Prints a formatted success message. printSuccess(String)

printErrorText

public void printErrorText(String message)

Prints an error message to stderr that will be highlighted in red if stderr is a tty.

printErrorText

public void printErrorText(String message,
                           Object... args)

Prints a formatted error message. printErrorText(String)

printBuildFailure

public void printBuildFailure(String failureMessage)

Prints an error message prefixed with BUILD FAILED to stderr that will be highlighted in red if stderr is a tty.

printFailure

public void printFailure(String failureMessage)

Prints error message to console in red, also logs stacktrace but does not display it