Package mastermind.utils

Enum Class ANSIColor

java.lang.Object

java.lang.Enum<ANSIColor>

mastermind.utils.ANSIColor

All Implemented Interfaces:

Serializable, Comparable<ANSIColor>, Constable

public enum ANSIColor
extends Enum<ANSIColor>

Represents an ANSI color code for console output.

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
CYAN	The ANSI cyan color code.
GRAY	The ANSI gray color code.
GREEN	The ANSI green color code.
RED	The ANSI red color code.
RED_BACKGROUND	The ANSI red background color code.
RESET	The ANSI reset color code.
YELLOW	The ANSI yellow color code.

Method Summary

Modifier and Type	Method	Description
static String	colorize(ANSIColor color, String msg)	Returns the provided string wrapped with the specified ANSI color code.
static ANSIColor	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ANSIColor[]	values()	Returns an array containing the constants of this enum class, 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

RESET

public static final ANSIColor RESET

The ANSI reset color code.

CYAN

public static final ANSIColor CYAN

The ANSI cyan color code.

GRAY

public static final ANSIColor GRAY

The ANSI gray color code.

GREEN

public static final ANSIColor GREEN

The ANSI green color code.

RED

public static final ANSIColor RED

The ANSI red color code.

RED_BACKGROUND

public static final ANSIColor RED_BACKGROUND

The ANSI red background color code.

YELLOW

public static final ANSIColor YELLOW

The ANSI yellow color code.

Method Details

values

public static ANSIColor[] values()

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

Returns:

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

valueOf

public static ANSIColor valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

colorize

public static String colorize(ANSIColor color,
 String msg)

Returns the provided string wrapped with the specified ANSI color code.

Parameters:

color - The ANSI color code to apply.

msg - The string to colorize.

Returns:

The colorized string.