Package com.esturafd.jtoolkit.console.ansi

Enum Background

java.lang.Object

java.lang.Enum<Background>

com.esturafd.jtoolkit.console.ansi.Background

All Implemented Interfaces:

Attribute, Sequence, java.io.Serializable, java.lang.Comparable<Background>

public enum Background
extends java.lang.Enum<Background>
implements Sequence, Attribute

List of colors supported by the text background on an ANSI console

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLACK
BLUE
CYAN
GREEN
MAGENTA
RED
RESET
WHITE
YELLOW

Field Summary

Fields inherited from interface com.esturafd.jtoolkit.console.ansi.Attribute

FORMAT

Fields inherited from interface com.esturafd.jtoolkit.console.ansi.Sequence

ESC

Method Summary

Modifier and Type	Method	Description
java.lang.String	getCode()
static java.lang.String	paint(Background color, java.lang.String text)	Paint the text background in ANSI console
java.lang.String	toString()
static Background	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static Background[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLACK

public static final Background BLACK

RED

public static final Background RED

GREEN

public static final Background GREEN

YELLOW

public static final Background YELLOW

BLUE

public static final Background BLUE

MAGENTA

public static final Background MAGENTA

CYAN

public static final Background CYAN

WHITE

public static final Background WHITE

RESET

public static final Background RESET

Method Detail

values

public static Background[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Background c : Background.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Background valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

paint

public static java.lang.String paint(Background color,
                                     java.lang.String text)

Paint the text background in ANSI console

Parameters:

color - background color

text - text to be colored

Returns:

text to be sent to the console

getCode

public java.lang.String getCode()

Specified by:

getCode in interface Sequence

Returns:

the raw attribute code

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Background>