net.aichler.jupiter.internal

Enum Color

java.lang.Object

java.lang.Enum<Color>

net.aichler.jupiter.internal.Color

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Color>

public enum Color
extends java.lang.Enum<Color>

Defines an enumeration of available colors.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static java.lang.String	filter(java.lang.String str) Filter color codes from the specified value.
java.lang.String	format(java.lang.String value)
java.lang.String	toString()
static Color	valueOf(java.lang.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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Color NONE

RESET

public static final Color RESET

BLACK

public static final Color BLACK

RED

public static final Color RED

GREEN

public static final Color GREEN

YELLOW

public static final Color YELLOW

BLUE

public static final Color BLUE

MAGENTA

public static final Color MAGENTA

CYAN

public static final Color CYAN

WHITE

public static final Color WHITE

Method Detail

values

public static Color[] 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 (Color c : Color.values())
    System.out.println(c);

Returns:

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

valueOf

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

filter

public static java.lang.String filter(java.lang.String str)

Filter color codes from the specified value.

Parameters:

str - The string which is to be filtered.

Returns:

The string without any color codes.

format

public java.lang.String format(java.lang.String value)

Parameters:

value - The string which is to be colored.

Returns:

The colored string.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<Color>

Returns:

The ANSI representation of this color.