Package org.aesh.terminal.utils

Enum ANSIBuilder.Color

java.lang.Object

java.lang.Enum<ANSIBuilder.Color>

org.aesh.terminal.utils.ANSIBuilder.Color

All Implemented Interfaces:

Serializable, Comparable<ANSIBuilder.Color>, java.lang.constant.Constable

Enclosing class:

ANSIBuilder

public static enum ANSIBuilder.Color
extends Enum<ANSIBuilder.Color>

Enumeration of ANSI color codes for text and background colors.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLACK	Black color.
BLUE	Blue color.
CYAN	Cyan color.
DEFAULT	Default terminal color.
GREEN	Green color.
MAGENTA	Magenta color.
RED	Red color.
WHITE	White color.
YELLOW	Yellow color.

Method Summary

Modifier and Type	Method	Description
int	bg()	Returns the ANSI code for background color.
int	text()	Returns the ANSI code for foreground text color.
String	toString()
int	value()	Returns the raw color value.
static ANSIBuilder.Color	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ANSIBuilder.Color[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BLACK

public static final ANSIBuilder.Color BLACK

Black color.

RED

public static final ANSIBuilder.Color RED

Red color.

GREEN

public static final ANSIBuilder.Color GREEN

Green color.

YELLOW

public static final ANSIBuilder.Color YELLOW

Yellow color.

BLUE

public static final ANSIBuilder.Color BLUE

Blue color.

MAGENTA

public static final ANSIBuilder.Color MAGENTA

Magenta color.

CYAN

public static final ANSIBuilder.Color CYAN

Cyan color.

WHITE

public static final ANSIBuilder.Color WHITE

White color.

DEFAULT

public static final ANSIBuilder.Color DEFAULT

Default terminal color.

Method Details

values

public static ANSIBuilder.Color[] values()

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

Returns:

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

valueOf

public static ANSIBuilder.Color valueOf(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:

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

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<ANSIBuilder.Color>

value

public int value()

Returns the raw color value.

Returns:

the color index value

text

public int text()

Returns the ANSI code for foreground text color.

Returns:

the text color ANSI code

bg

public int bg()

Returns the ANSI code for background color.

Returns:

the background color ANSI code