com.atlassian.clover.util

Class Color

java.lang.Object

com.atlassian.clover.util.Color

public class Color
extends Object

A small Java implementation of ANSI_escape_code .

To enable Color formatting, the ansi.color System property must be set to true. To enable Color formatting for a specific category, the ansi.color System property must be set to the category name. e.g. -Dansi.color=true or -Dansi.color=category.name

This class uses the Builder Pattern, to allow combining formats. The color should always be called after the format (bg, u(), b() etc) e.g. for a blue background and a bold, white foreground you would use: new Color("some important message").b().white().bg().blue();

Method Summary

Modifier and Type	Method and Description
String	apply(String msg)
Color	b()
Color	bg()
Color	black()
Color	blue()
static Color	colorFor(String categoryName) Creates a color, with a specific appender name.
Color	cyan()
String	getMsg()
Color	green()
Color	i()
Color	majenta()
static Color	make(String msg) Creates a color instance with a given message.
Color	red()
String	toString()
Color	u()
Color	white()
Color	yellow()

Methods inherited from class java.lang.Object

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

Method Detail

colorFor

public static Color colorFor(String categoryName)

Creates a color, with a specific appender name.

This allows output of ansi formatting to be decided at runtime. To enable color output just for the category 'categoryName' ensure the system property ansi.color is set to 'categoryName'. e.g. -Dansi.color=categoryName

Parameters:

categoryName - the name of the category for this color.

Returns:

a new instance of color for the given the given category name.

make

public static Color make(String msg)

Creates a color instance with a given message.

Parameters:

msg - the message to use when formatting this color. NB: this may be overwritten by apply(java.lang.String)

b

public Color b()

i

public Color i()

u

public Color u()

black

public Color black()

yellow

public Color yellow()

blue

public Color blue()

majenta

public Color majenta()

cyan

public Color cyan()

white

public Color white()

red

public Color red()

green

public Color green()

bg

public Color bg()

toString

public String toString()

Overrides:

toString in class Object

getMsg

public String getMsg()

apply

public String apply(String msg)