org.refcodes.data

Enum AnsiEscapeCode

java.lang.Object

java.lang.Enum<AnsiEscapeCode>

org.refcodes.data.AnsiEscapeCode

All Implemented Interfaces:

Serializable, Comparable<AnsiEscapeCode>, org.refcodes.mixin.CodeAccessor<String>

public enum AnsiEscapeCode
extends Enum<AnsiEscapeCode>
implements org.refcodes.mixin.CodeAccessor<String>

Some defauilt ANSI escape codes to be prepended or append RESET to your ANSIfied String instances.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.CodeAccessor

org.refcodes.mixin.CodeAccessor.CodeBuilder<V,B extends org.refcodes.mixin.CodeAccessor.CodeBuilder<V,B>>, org.refcodes.mixin.CodeAccessor.CodeMutator<V>, org.refcodes.mixin.CodeAccessor.CodeProperty<V>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESC
FG_BLUE_BRIGHT
FG_BLUE_BRIGHT_BOLD
FG_DEFAULT_BRIGHT
FG_GREEN_BRIGHT
FG_RED
FG_RED_BRIGHT
FG_RED_BRIGHT_BOLD
FG_WHITE
FG_WHITE_BRIGHT_BG_BLACK
FG_WHITE_BRIGHT_BG_RED
FG_WHITE_UNDERLINE
FG_YELLOW_BRIGHT_BG_BLUE_BRIGHT
RESET

Method Summary

Modifier and Type	Method and Description
String	getCode()
String	toEscaped() Returns the escaped ANSI escape code to be printable without triggering the actual ANSI escape commands.
static AnsiEscapeCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnsiEscapeCode[]	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

RESET

public static final AnsiEscapeCode RESET

FG_WHITE

public static final AnsiEscapeCode FG_WHITE

FG_WHITE_UNDERLINE

public static final AnsiEscapeCode FG_WHITE_UNDERLINE

FG_WHITE_BRIGHT_BG_BLACK

public static final AnsiEscapeCode FG_WHITE_BRIGHT_BG_BLACK

FG_RED_BRIGHT_BOLD

public static final AnsiEscapeCode FG_RED_BRIGHT_BOLD

FG_WHITE_BRIGHT_BG_RED

public static final AnsiEscapeCode FG_WHITE_BRIGHT_BG_RED

FG_GREEN_BRIGHT

public static final AnsiEscapeCode FG_GREEN_BRIGHT

FG_RED

public static final AnsiEscapeCode FG_RED

FG_BLUE_BRIGHT_BOLD

public static final AnsiEscapeCode FG_BLUE_BRIGHT_BOLD

FG_DEFAULT_BRIGHT

public static final AnsiEscapeCode FG_DEFAULT_BRIGHT

FG_BLUE_BRIGHT

public static final AnsiEscapeCode FG_BLUE_BRIGHT

FG_RED_BRIGHT

public static final AnsiEscapeCode FG_RED_BRIGHT

FG_YELLOW_BRIGHT_BG_BLUE_BRIGHT

public static final AnsiEscapeCode FG_YELLOW_BRIGHT_BG_BLUE_BRIGHT

ESC

public static final AnsiEscapeCode ESC

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public String getCode()

Specified by:

getCode in interface org.refcodes.mixin.CodeAccessor<String>

toEscaped

public String toEscaped()

Returns the escaped ANSI escape code to be printable without triggering the actual ANSI escape commands.

Returns:

The escaped ANSI escape code.