com.facebook.buck.event.listener

Class RenderingConsole

java.lang.Object

com.facebook.buck.event.listener.RenderingConsole

public class RenderingConsole
extends Object

A console that supports rendering.

The Delegate provides the "Super" lines for the rendered frame, log lines will be queued by the RenderingConsole.

If no delegate is configured (or if rendering is not running), lines will be logged immediately and won't be queued for the next frame.

If something writes to the underlying Console's stderr/stdout streams, rendering will be disabled. If something writes to the real underlying stderr/stdout, we won't notice and it will get overwritten.

TODO(cjhopman): For both those stderr/stdout cases, we should just capture the logging and queue it the same as logging that goes explicitly to the RenderingConsole. For real System.err/System.out we might need something a little fancy.

Constructor Summary

Constructors

Constructor and Description
RenderingConsole(Clock clock, Console console)

Method Summary

Modifier and Type	Method and Description
protected void	clearPendingLogLines()
void	close() Shuts down rendering.
Ansi	getAnsi()
protected com.google.common.collect.ImmutableList<String>	getPendingLogLines()
Verbosity	getVerbosity()
boolean	isRendering()
void	logLines(Collection<String> lines) Logs the provided lines to stderr.
void	logLines(String... lines) Logs the provided lines to stderr.
void	printToStdOut(String testOutput) Deprecated.
void	registerDelegate(com.facebook.buck.event.listener.RenderingConsole.Delegate delegate) Registers a delegate to provide the data to render and starts the rendering thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderingConsole

public RenderingConsole(Clock clock,
                        Console console)

Method Detail

getAnsi

public Ansi getAnsi()

getVerbosity

public Verbosity getVerbosity()

registerDelegate

public void registerDelegate(com.facebook.buck.event.listener.RenderingConsole.Delegate delegate)

Registers a delegate to provide the data to render and starts the rendering thread.

logLines

public void logLines(String... lines)

Logs the provided lines to stderr. When rendering, this will be queued until the next rendered frame.

logLines

public void logLines(Collection<String> lines)

Logs the provided lines to stderr. When rendering, this will be queued until the next rendered frame.

printToStdOut

@Deprecated
public void printToStdOut(String testOutput)

Deprecated.

This prints to stdout and disables rendering. It shouldn't be used.

getPendingLogLines

protected com.google.common.collect.ImmutableList<String> getPendingLogLines()

clearPendingLogLines

protected void clearPendingLogLines()

close

public void close()

Shuts down rendering. If rendering, will print at least one final frame.

Logging after calling close() will not be queued.

isRendering

public boolean isRendering()