Package com.planet_ink.coffee_mud.Libraries.interfaces

Enum ColorLibrary.Color

java.lang.Object

java.lang.Enum<ColorLibrary.Color>

com.planet_ink.coffee_mud.Libraries.interfaces.ColorLibrary.Color

All Implemented Interfaces:

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

Enclosing interface:

ColorLibrary

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

These are the straight color codes and character codes such as blink adn so forth. Includes back and foreground, and lots of codes for each one, including ansi codes, html tags, ^ codes, and so forth.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BGBLACK
BGBLUE
BGCYAN
BGDEFAULT
BGGREEN
BGPURPLE
BGRED
BGWHITE
BGYELLOW
BLACK
BLINK
BLUE
BOLD
BROWN
CYAN
DARKGREY
GREEN
GREY
ITALICS
LIGHTBLUE
LIGHTCYAN
LIGHTGREEN
LIGHTPURPLE
LIGHTRED
NONE
PURPLE
RED
UNDERLINE
WHITE
YELLOW

Method Summary

Modifier and Type	Method	Description
java.lang.String	getANSICode()	Returns the ANSI escape codes for this color.
char	getBGCodeChar()	Returns the ^~ char code, or 0 if its not a basic color
char	getCodeChar()	Returns the ^ char code, or 0 if its not a basic color
java.lang.String	getCodeString()	Returns the name, but with - instead of _
java.lang.String	getHtmlTag()	Returns the HTML tag for this color code
boolean	isBasicColor()	True if its a basic 16 color, but also non-black.
static ColorLibrary.Color	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ColorLibrary.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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WHITE

public static final ColorLibrary.Color WHITE

LIGHTGREEN

public static final ColorLibrary.Color LIGHTGREEN

LIGHTBLUE

public static final ColorLibrary.Color LIGHTBLUE

LIGHTRED

public static final ColorLibrary.Color LIGHTRED

YELLOW

public static final ColorLibrary.Color YELLOW

LIGHTCYAN

public static final ColorLibrary.Color LIGHTCYAN

LIGHTPURPLE

public static final ColorLibrary.Color LIGHTPURPLE

GREY

public static final ColorLibrary.Color GREY

GREEN

public static final ColorLibrary.Color GREEN

BLUE

public static final ColorLibrary.Color BLUE

RED

public static final ColorLibrary.Color RED

BROWN

public static final ColorLibrary.Color BROWN

CYAN

public static final ColorLibrary.Color CYAN

PURPLE

public static final ColorLibrary.Color PURPLE

DARKGREY

public static final ColorLibrary.Color DARKGREY

BLACK

public static final ColorLibrary.Color BLACK

NONE

public static final ColorLibrary.Color NONE

BOLD

public static final ColorLibrary.Color BOLD

UNDERLINE

public static final ColorLibrary.Color UNDERLINE

BLINK

public static final ColorLibrary.Color BLINK

ITALICS

public static final ColorLibrary.Color ITALICS

BGWHITE

public static final ColorLibrary.Color BGWHITE

BGGREEN

public static final ColorLibrary.Color BGGREEN

BGBLUE

public static final ColorLibrary.Color BGBLUE

BGRED

public static final ColorLibrary.Color BGRED

BGYELLOW

public static final ColorLibrary.Color BGYELLOW

BGCYAN

public static final ColorLibrary.Color BGCYAN

BGPURPLE

public static final ColorLibrary.Color BGPURPLE

BGBLACK

public static final ColorLibrary.Color BGBLACK

BGDEFAULT

public static final ColorLibrary.Color BGDEFAULT

Method Detail

values

public static ColorLibrary.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 (ColorLibrary.Color c : ColorLibrary.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 ColorLibrary.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

isBasicColor

public final boolean isBasicColor()

True if its a basic 16 color, but also non-black.

Returns:

its a basic 16 color, but also non-black.

getHtmlTag

public final java.lang.String getHtmlTag()

Returns the HTML tag for this color code

Returns:

the HTML tag for this color code

getANSICode

public final java.lang.String getANSICode()

Returns the ANSI escape codes for this color.

Returns:

the ANSI escape codes for this color.

getCodeChar

public final char getCodeChar()

Returns the ^ char code, or 0 if its not a basic color

Returns:

the ^ char code, or 0 if its not a basic color

getBGCodeChar

public final char getBGCodeChar()

Returns the ^~ char code, or 0 if its not a basic color

Returns:

the ^~ char code, or 0 if its not a basic color

getCodeString

public final java.lang.String getCodeString()

Returns the name, but with - instead of _

Returns:

the name, but with - instead of _