Package org.aesh.terminal.formatting

Enum Color

java.lang.Object

java.lang.Enum<Color>

org.aesh.terminal.formatting.Color

All Implemented Interfaces:

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

public enum Color
extends Enum<Color>

Enumeration of ANSI terminal colors with intensity and type options.

Author:

Ståle W. Pedersen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Color.Intensity	Color intensity levels for ANSI terminal colors.
static enum	Color.Type	Specifies whether a color applies to foreground or background.

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 (ANSI code 0).
BLUE	Blue color (ANSI code 4).
CYAN	Cyan color (ANSI code 6).
DEFAULT	Default terminal color (ANSI code 9).
GREEN	Green color (ANSI code 2).
MAGENTA	Magenta color (ANSI code 5).
RED	Red color (ANSI code 1).
WHITE	White color (ANSI code 7).
YELLOW	Yellow color (ANSI code 3).

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the ANSI color code value.
static Color	valueOf(String name)	Returns the enum constant of this type with the specified name.
static 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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BLACK

public static final Color BLACK

Black color (ANSI code 0).

RED

public static final Color RED

Red color (ANSI code 1).

GREEN

public static final Color GREEN

Green color (ANSI code 2).

YELLOW

public static final Color YELLOW

Yellow color (ANSI code 3).

BLUE

public static final Color BLUE

Blue color (ANSI code 4).

MAGENTA

public static final Color MAGENTA

Magenta color (ANSI code 5).

CYAN

public static final Color CYAN

Cyan color (ANSI code 6).

WHITE

public static final Color WHITE

White color (ANSI code 7).

DEFAULT

public static final Color DEFAULT

Default terminal color (ANSI code 9).

Method Details

values

public static 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 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

getValue

public int getValue()

Returns the ANSI color code value.

Returns:

the ANSI color code value