Top Description Inners Fields Constructors Methods
org.fusesource.jansi

public Class AnsiRenderer

extends Object
Class Inheritance
Imports
java.io.IOException, java.util.Locale, org.fusesource.jansi.Ansi.Attribute, .Ansi.Color
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
2.2

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
AnsiRenderer.Code

Field Summary

Modifier and TypeField and Description
public static final String
BEGIN_TOKEN

private static final int
BEGIN_TOKEN_LEN

public static final String
CODE_LIST_SEPARATOR

public static final String
CODE_TEXT_SEPARATOR

public static final String
END_TOKEN

private static final int
END_TOKEN_LEN

Constructor Summary

AccessConstructor and Description
private
AnsiRenderer()

Method Summary

Modifier and TypeMethod and Description
public static String
render(final String input)

public static Appendable

Returns:

the given Appendable
render(final String
source to render
input, Appendable
render onto this target Appendable.
target)

Renders the given input to the target Appendable.

public static String
render(final String text, final String... codes)

private static Ansi
render(Ansi ansi, String... names)

public static String

Returns:

an ANSI escape string.
renderCodes(final String...
The code names to render
codes)

Renders Code names as an ANSI escape string.

public static String

Returns:

an ANSI escape string.
renderCodes(final String
A space separated list of code names to render
codes)

Renders Code names as an ANSI escape string.

public static boolean
test(final String text)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

BEGIN_TOKENback to summary
public static final String BEGIN_TOKEN
BEGIN_TOKEN_LENback to summary
private static final int BEGIN_TOKEN_LEN
CODE_LIST_SEPARATORback to summary
public static final String CODE_LIST_SEPARATOR
CODE_TEXT_SEPARATORback to summary
public static final String CODE_TEXT_SEPARATOR
END_TOKENback to summary
public static final String END_TOKEN
END_TOKEN_LENback to summary
private static final int END_TOKEN_LEN

Constructor Detail

AnsiRendererback to summary
private AnsiRenderer()

Method Detail

renderback to summary
public static String render(final String input) throws IllegalArgumentException
renderback to summary
public static Appendable render(final String input, Appendable target) throws IOException

Renders the given input to the target Appendable.

Parameters
input:String

source to render

target:Appendable

render onto this target Appendable.

Returns:Appendable

the given Appendable

Exceptions
IOException:
If an I/O error occurs
renderback to summary
public static String render(final String text, final String... codes)
renderback to summary
private static Ansi render(Ansi ansi, String... names)
renderCodesback to summary
public static String renderCodes(final String... codes)

Renders Code names as an ANSI escape string.

Parameters
codes:String[]

The code names to render

Returns:String

an ANSI escape string.

renderCodesback to summary
public static String renderCodes(final String codes)

Renders Code names as an ANSI escape string.

Parameters
codes:String

A space separated list of code names to render

Returns:String

an ANSI escape string.

testback to summary
public static boolean test(final String text)
org.fusesource.jansi back to summary

public final Enum AnsiRenderer.Code

extends Enum<AnsiRenderer.Code>
Class Inheritance
Annotations
@SuppressWarnings:unused

Field Summary

Modifier and TypeField and Description
private final boolean
background

public static final AnsiRenderer.Code
BG_BLACK

public static final AnsiRenderer.Code
BG_BLUE

public static final AnsiRenderer.Code
BG_CYAN

public static final AnsiRenderer.Code
BG_DEFAULT

public static final AnsiRenderer.Code
BG_GREEN

public static final AnsiRenderer.Code
BG_MAGENTA

public static final AnsiRenderer.Code
BG_RED

public static final AnsiRenderer.Code
BG_WHITE

public static final AnsiRenderer.Code
BG_YELLOW

public static final AnsiRenderer.Code
BLACK

public static final AnsiRenderer.Code
BLUE

public static final AnsiRenderer.Code
BOLD

public static final AnsiRenderer.Code
CONCEAL_OFF

public static final AnsiRenderer.Code
CONCEAL_ON

public static final AnsiRenderer.Code
CYAN

public static final AnsiRenderer.Code
DEFAULT

public static final AnsiRenderer.Code
FAINT

public static final AnsiRenderer.Code
FG_BLACK

public static final AnsiRenderer.Code
FG_BLUE

public static final AnsiRenderer.Code
FG_CYAN

public static final AnsiRenderer.Code
FG_DEFAULT

public static final AnsiRenderer.Code
FG_GREEN

public static final AnsiRenderer.Code
FG_MAGENTA

public static final AnsiRenderer.Code
FG_RED

public static final AnsiRenderer.Code
FG_WHITE

public static final AnsiRenderer.Code
FG_YELLOW

public static final AnsiRenderer.Code
GREEN

public static final AnsiRenderer.Code
INTENSITY_BOLD

public static final AnsiRenderer.Code
INTENSITY_FAINT

public static final AnsiRenderer.Code
ITALIC

public static final AnsiRenderer.Code
MAGENTA

private final Enum<?>
n

public static final AnsiRenderer.Code
NEGATIVE_OFF

public static final AnsiRenderer.Code
NEGATIVE_ON

public static final AnsiRenderer.Code
RED

public static final AnsiRenderer.Code
RESET

public static final AnsiRenderer.Code
UNDERLINE

public static final AnsiRenderer.Code
UNDERLINE_DOUBLE

public static final AnsiRenderer.Code
UNDERLINE_OFF

public static final AnsiRenderer.Code
WHITE

public static final AnsiRenderer.Code
YELLOW

Constructor Summary

AccessConstructor and Description
private
Code(final Enum<?> n, boolean background)

private
Code(final Enum<?> n)

Method Summary

Modifier and TypeMethod and Description
public Ansi.Attribute
getAttribute()

public Ansi.Color
getColor()

public boolean
isAttribute()

public boolean
isBackground()

public boolean
isColor()

public static AnsiRenderer.Code
valueOf(String name)

public static AnsiRenderer.Code[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

backgroundback to summary
private final boolean background
BG_BLACKback to summary
public static final AnsiRenderer.Code BG_BLACK
BG_BLUEback to summary
public static final AnsiRenderer.Code BG_BLUE
BG_CYANback to summary
public static final AnsiRenderer.Code BG_CYAN
BG_DEFAULTback to summary
public static final AnsiRenderer.Code BG_DEFAULT
BG_GREENback to summary
public static final AnsiRenderer.Code BG_GREEN
BG_MAGENTAback to summary
public static final AnsiRenderer.Code BG_MAGENTA
BG_REDback to summary
public static final AnsiRenderer.Code BG_RED
BG_WHITEback to summary
public static final AnsiRenderer.Code BG_WHITE
BG_YELLOWback to summary
public static final AnsiRenderer.Code BG_YELLOW
BLACKback to summary
public static final AnsiRenderer.Code BLACK
BLUEback to summary
public static final AnsiRenderer.Code BLUE
BOLDback to summary
public static final AnsiRenderer.Code BOLD
CONCEAL_OFFback to summary
public static final AnsiRenderer.Code CONCEAL_OFF
CONCEAL_ONback to summary
public static final AnsiRenderer.Code CONCEAL_ON
CYANback to summary
public static final AnsiRenderer.Code CYAN
DEFAULTback to summary
public static final AnsiRenderer.Code DEFAULT
FAINTback to summary
public static final AnsiRenderer.Code FAINT
FG_BLACKback to summary
public static final AnsiRenderer.Code FG_BLACK
FG_BLUEback to summary
public static final AnsiRenderer.Code FG_BLUE
FG_CYANback to summary
public static final AnsiRenderer.Code FG_CYAN
FG_DEFAULTback to summary
public static final AnsiRenderer.Code FG_DEFAULT
FG_GREENback to summary
public static final AnsiRenderer.Code FG_GREEN
FG_MAGENTAback to summary
public static final AnsiRenderer.Code FG_MAGENTA
FG_REDback to summary
public static final AnsiRenderer.Code FG_RED
FG_WHITEback to summary
public static final AnsiRenderer.Code FG_WHITE
FG_YELLOWback to summary
public static final AnsiRenderer.Code FG_YELLOW
GREENback to summary
public static final AnsiRenderer.Code GREEN
INTENSITY_BOLDback to summary
public static final AnsiRenderer.Code INTENSITY_BOLD
INTENSITY_FAINTback to summary
public static final AnsiRenderer.Code INTENSITY_FAINT
ITALICback to summary
public static final AnsiRenderer.Code ITALIC
MAGENTAback to summary
public static final AnsiRenderer.Code MAGENTA
nback to summary
private final Enum<?> n
NEGATIVE_OFFback to summary
public static final AnsiRenderer.Code NEGATIVE_OFF
NEGATIVE_ONback to summary
public static final AnsiRenderer.Code NEGATIVE_ON
REDback to summary
public static final AnsiRenderer.Code RED
RESETback to summary
public static final AnsiRenderer.Code RESET
UNDERLINEback to summary
public static final AnsiRenderer.Code UNDERLINE
UNDERLINE_DOUBLEback to summary
public static final AnsiRenderer.Code UNDERLINE_DOUBLE
UNDERLINE_OFFback to summary
public static final AnsiRenderer.Code UNDERLINE_OFF
WHITEback to summary
public static final AnsiRenderer.Code WHITE
YELLOWback to summary
public static final AnsiRenderer.Code YELLOW

Constructor Detail

Codeback to summary
private Code(final Enum<?> n, boolean background)
Codeback to summary
private Code(final Enum<?> n)

Method Detail

getAttributeback to summary
public Ansi.Attribute getAttribute()
getColorback to summary
public Ansi.Color getColor()
isAttributeback to summary
public boolean isAttribute()
isBackgroundback to summary
public boolean isBackground()
isColorback to summary
public boolean isColor()
valueOfback to summary
public static AnsiRenderer.Code valueOf(String name)
valuesback to summary
public static AnsiRenderer.Code[] values()