com.frostdeveloper.api.utility

Enum ConsoleColor

java.lang.Object

java.lang.Enum<ConsoleColor>

com.frostdeveloper.api.utility.ConsoleColor

All Implemented Interfaces:

Serializable, Comparable<ConsoleColor>

public enum ConsoleColor
extends Enum<ConsoleColor>

A class used to create methods to get instance of console colors.

Since:

1.0.0

Author:

OMGitzFROST

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLACK
BLACK_BACKGROUND
BLACK_BACKGROUND_BRIGHT
BLACK_BOLD
BLACK_BOLD_BRIGHT
BLACK_BRIGHT
BLACK_UNDERLINED
BLUE
BLUE_BACKGROUND
BLUE_BACKGROUND_BRIGHT
BLUE_BOLD
BLUE_BOLD_BRIGHT
BLUE_BRIGHT
BLUE_UNDERLINED
CYAN
CYAN_BACKGROUND
CYAN_BACKGROUND_BRIGHT
CYAN_BOLD
CYAN_BOLD_BRIGHT
CYAN_BRIGHT
CYAN_UNDERLINED
GREEN
GREEN_BACKGROUND
GREEN_BACKGROUND_BRIGHT
GREEN_BOLD
GREEN_BOLD_BRIGHT
GREEN_BRIGHT
GREEN_UNDERLINED
MAGENTA
MAGENTA_BACKGROUND
MAGENTA_BACKGROUND_BRIGHT
MAGENTA_BOLD
MAGENTA_BOLD_BRIGHT
MAGENTA_BRIGHT
MAGENTA_UNDERLINED
RED
RED_BACKGROUND
RED_BACKGROUND_BRIGHT
RED_BOLD
RED_BOLD_BRIGHT
RED_BRIGHT
RED_UNDERLINED
RESET
WHITE
WHITE_BACKGROUND
WHITE_BACKGROUND_BRIGHT
WHITE_BOLD
WHITE_BOLD_BRIGHT
WHITE_BRIGHT
WHITE_UNDERLINED
YELLOW
YELLOW_BACKGROUND
YELLOW_BACKGROUND_BRIGHT
YELLOW_BOLD
YELLOW_BOLD_BRIGHT
YELLOW_BRIGHT
YELLOW_UNDERLINED

Method Summary

Modifier and Type	Method and Description
static @NotNull String	add(ConsoleColor color, String input) A method used to add a color to a console message, this method will always automatically include a reset at the end of the string.
static @NotNull String	remove(String input) A method used to remove an enum color from an input, if not color was found this method will return the unchanged original string.
String	toString() A method used to get the color code for a console color
static ConsoleColor	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConsoleColor[]	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

RESET

public static final ConsoleColor RESET

BLACK

public static final ConsoleColor BLACK

RED

public static final ConsoleColor RED

GREEN

public static final ConsoleColor GREEN

YELLOW

public static final ConsoleColor YELLOW

BLUE

public static final ConsoleColor BLUE

MAGENTA

public static final ConsoleColor MAGENTA

CYAN

public static final ConsoleColor CYAN

WHITE

public static final ConsoleColor WHITE

BLACK_BOLD

public static final ConsoleColor BLACK_BOLD

RED_BOLD

public static final ConsoleColor RED_BOLD

GREEN_BOLD

public static final ConsoleColor GREEN_BOLD

YELLOW_BOLD

public static final ConsoleColor YELLOW_BOLD

BLUE_BOLD

public static final ConsoleColor BLUE_BOLD

MAGENTA_BOLD

public static final ConsoleColor MAGENTA_BOLD

CYAN_BOLD

public static final ConsoleColor CYAN_BOLD

WHITE_BOLD

public static final ConsoleColor WHITE_BOLD

BLACK_UNDERLINED

public static final ConsoleColor BLACK_UNDERLINED

RED_UNDERLINED

public static final ConsoleColor RED_UNDERLINED

GREEN_UNDERLINED

public static final ConsoleColor GREEN_UNDERLINED

YELLOW_UNDERLINED

public static final ConsoleColor YELLOW_UNDERLINED

BLUE_UNDERLINED

public static final ConsoleColor BLUE_UNDERLINED

MAGENTA_UNDERLINED

public static final ConsoleColor MAGENTA_UNDERLINED

CYAN_UNDERLINED

public static final ConsoleColor CYAN_UNDERLINED

WHITE_UNDERLINED

public static final ConsoleColor WHITE_UNDERLINED

BLACK_BACKGROUND

public static final ConsoleColor BLACK_BACKGROUND

RED_BACKGROUND

public static final ConsoleColor RED_BACKGROUND

GREEN_BACKGROUND

public static final ConsoleColor GREEN_BACKGROUND

YELLOW_BACKGROUND

public static final ConsoleColor YELLOW_BACKGROUND

BLUE_BACKGROUND

public static final ConsoleColor BLUE_BACKGROUND

MAGENTA_BACKGROUND

public static final ConsoleColor MAGENTA_BACKGROUND

CYAN_BACKGROUND

public static final ConsoleColor CYAN_BACKGROUND

WHITE_BACKGROUND

public static final ConsoleColor WHITE_BACKGROUND

BLACK_BRIGHT

public static final ConsoleColor BLACK_BRIGHT

RED_BRIGHT

public static final ConsoleColor RED_BRIGHT

GREEN_BRIGHT

public static final ConsoleColor GREEN_BRIGHT

YELLOW_BRIGHT

public static final ConsoleColor YELLOW_BRIGHT

BLUE_BRIGHT

public static final ConsoleColor BLUE_BRIGHT

MAGENTA_BRIGHT

public static final ConsoleColor MAGENTA_BRIGHT

CYAN_BRIGHT

public static final ConsoleColor CYAN_BRIGHT

WHITE_BRIGHT

public static final ConsoleColor WHITE_BRIGHT

BLACK_BOLD_BRIGHT

public static final ConsoleColor BLACK_BOLD_BRIGHT

RED_BOLD_BRIGHT

public static final ConsoleColor RED_BOLD_BRIGHT

GREEN_BOLD_BRIGHT

public static final ConsoleColor GREEN_BOLD_BRIGHT

YELLOW_BOLD_BRIGHT

public static final ConsoleColor YELLOW_BOLD_BRIGHT

BLUE_BOLD_BRIGHT

public static final ConsoleColor BLUE_BOLD_BRIGHT

MAGENTA_BOLD_BRIGHT

public static final ConsoleColor MAGENTA_BOLD_BRIGHT

CYAN_BOLD_BRIGHT

public static final ConsoleColor CYAN_BOLD_BRIGHT

WHITE_BOLD_BRIGHT

public static final ConsoleColor WHITE_BOLD_BRIGHT

BLACK_BACKGROUND_BRIGHT

public static final ConsoleColor BLACK_BACKGROUND_BRIGHT

RED_BACKGROUND_BRIGHT

public static final ConsoleColor RED_BACKGROUND_BRIGHT

GREEN_BACKGROUND_BRIGHT

public static final ConsoleColor GREEN_BACKGROUND_BRIGHT

YELLOW_BACKGROUND_BRIGHT

public static final ConsoleColor YELLOW_BACKGROUND_BRIGHT

BLUE_BACKGROUND_BRIGHT

public static final ConsoleColor BLUE_BACKGROUND_BRIGHT

MAGENTA_BACKGROUND_BRIGHT

public static final ConsoleColor MAGENTA_BACKGROUND_BRIGHT

CYAN_BACKGROUND_BRIGHT

public static final ConsoleColor CYAN_BACKGROUND_BRIGHT

WHITE_BACKGROUND_BRIGHT

public static final ConsoleColor WHITE_BACKGROUND_BRIGHT

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

A method used to get the color code for a console color

Overrides:

toString in class Enum<ConsoleColor>

Returns:

Console color value

Since:

1.0.0

add

@NotNull
public static @NotNull String add(ConsoleColor color,
                                           String input)

A method used to add a color to a console message, this method will always automatically include a reset at the end of the string.

Parameters:

color - Target Color

input - Target input

Returns:

Color formatted string

Since:

1.1.0

remove

@NotNull
public static @NotNull String remove(String input)

A method used to remove an enum color from an input, if not color was found this method will return the unchanged original string.

Parameters:

input - Target input

Returns:

Stripped output

Since:

1.1.0