com.facebook.buck.util

Class Ansi

java.lang.Object

com.facebook.buck.util.Ansi

public final class Ansi
extends Object

Encapsulates the specifics of writing to a particular kind of terminal.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ansi.SeverityLevel

Constructor Summary

Constructors

Constructor and Description
Ansi(boolean isAnsiTerminal) Construct an Ansi object and conditionally enable fancy escape sequences.

Method Summary

Modifier and Type	Method and Description
String	asErrorText(String text)
String	asGreenText(String text)
String	asHighlightedFailureText(String text)
String	asHighlightedStatusText(Ansi.SeverityLevel level, String text)
String	asHighlightedSuccessText(String text)
String	asHighlightedWarningText(String text)
String	asInformationText(String text)
Iterable<String>	asNoWrap(Iterable<String> textParts)
String	asRedText(String text)
String	asSubtleText(String text)
String	asSuccessText(String text)
String	asWarningText(String text)
String	clearLine() Clears the line the cursor is currently on.
String	clearToTheEndOfLine() Clears from the cursor to the end of line.
String	cursorPreviousLine(int y) Moves the cursor y lines up.
static Ansi	forceTty()
String	getHighlightedResetSequence()
String	getHighlightedWarningSequence()
boolean	isAnsiTerminal()
void	printHighlightedSuccessText(PrintStream stream, String text)
void	printlnHighlightedFailureText(PrintStream stream, String text)
static Ansi	withoutTty()

Methods inherited from class java.lang.Object

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

Constructor Detail

Ansi

public Ansi(boolean isAnsiTerminal)

Construct an Ansi object and conditionally enable fancy escape sequences.

Method Detail

withoutTty

public static Ansi withoutTty()

forceTty

public static Ansi forceTty()

isAnsiTerminal

public boolean isAnsiTerminal()

asErrorText

public String asErrorText(String text)

asWarningText

public String asWarningText(String text)

asSuccessText

public String asSuccessText(String text)

asSubtleText

public String asSubtleText(String text)

asInformationText

public String asInformationText(String text)

asGreenText

public String asGreenText(String text)

asRedText

public String asRedText(String text)

getHighlightedWarningSequence

public String getHighlightedWarningSequence()

getHighlightedResetSequence

public String getHighlightedResetSequence()

asHighlightedFailureText

public String asHighlightedFailureText(String text)

asHighlightedWarningText

public String asHighlightedWarningText(String text)

asHighlightedSuccessText

public String asHighlightedSuccessText(String text)

asNoWrap

public Iterable<String> asNoWrap(Iterable<String> textParts)

printHighlightedSuccessText

public void printHighlightedSuccessText(PrintStream stream,
                                        String text)

printlnHighlightedFailureText

public void printlnHighlightedFailureText(PrintStream stream,
                                          String text)

asHighlightedStatusText

public String asHighlightedStatusText(Ansi.SeverityLevel level,
                                      String text)

cursorPreviousLine

public String cursorPreviousLine(int y)

Moves the cursor y lines up.

clearLine

public String clearLine()

Clears the line the cursor is currently on.

clearToTheEndOfLine

public String clearToTheEndOfLine()

Clears from the cursor to the end of line.