Package org.fusesource.jansi

Class AnsiRenderer

java.lang.Object

org.fusesource.jansi.AnsiRenderer

public class AnsiRenderer
extends java.lang.Object

Renders ANSI color escape-codes in strings by parsing out some special syntax to pick up the correct fluff to use. The syntax for embedded ANSI codes is:

   @|code(,code)* text|@
 

Examples:

   @|bold Hello|@
 

   @|bold,red Warning!|@
 

Since:

1.1

Author:

Jason Dillon, Hiram Chirino

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnsiRenderer.Code

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BEGIN_TOKEN
static java.lang.String	CODE_LIST_SEPARATOR
static java.lang.String	CODE_TEXT_SEPARATOR
static java.lang.String	END_TOKEN

Method Summary

Modifier and Type	Method	Description
static java.lang.String	render(java.lang.String input)
static java.lang.Appendable	render(java.lang.String input, java.lang.Appendable target)	Renders the given input to the target Appendable.
static java.lang.String	render(java.lang.String text, java.lang.String... codes)
static java.lang.String	renderCodes(java.lang.String codes)	Renders AnsiRenderer.Code names as an ANSI escape string.
static java.lang.String	renderCodes(java.lang.String... codes)	Renders AnsiRenderer.Code names as an ANSI escape string.
static boolean	test(java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

BEGIN_TOKEN

public static final java.lang.String BEGIN_TOKEN

See Also:

Constant Field Values

END_TOKEN

public static final java.lang.String END_TOKEN

See Also:

Constant Field Values

CODE_TEXT_SEPARATOR

public static final java.lang.String CODE_TEXT_SEPARATOR

See Also:

Constant Field Values

CODE_LIST_SEPARATOR

public static final java.lang.String CODE_LIST_SEPARATOR

See Also:

Constant Field Values

Method Detail

render

public static java.lang.String render(java.lang.String input)
                               throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

render

public static java.lang.Appendable render(java.lang.String input,
                                          java.lang.Appendable target)
                                   throws java.io.IOException

Renders the given input to the target Appendable.

Parameters:

input - source to render

target - render onto this target Appendable.

Returns:

the given Appendable

Throws:

java.io.IOException - If an I/O error occurs

render

public static java.lang.String render(java.lang.String text,
                                      java.lang.String... codes)

renderCodes

public static java.lang.String renderCodes(java.lang.String... codes)

Renders AnsiRenderer.Code names as an ANSI escape string.

Parameters:

codes - The code names to render

Returns:

an ANSI escape string.

renderCodes

public static java.lang.String renderCodes(java.lang.String codes)

Renders AnsiRenderer.Code names as an ANSI escape string.

Parameters:

codes - A space separated list of code names to render

Returns:

an ANSI escape string.

test

public static boolean test(java.lang.String text)