Package dev.prozilla.pine.common.system

Class Ansi

java.lang.Object

dev.prozilla.pine.common.system.Ansi

public final class Ansi
extends Object

Utility class for constructing ANSI escape sequences.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BLACK
static final String	BLACK_BACKGROUND
static final String	BLUE
static final String	BLUE_BACKGROUND
static final String	BOLD
static final String	CYAN
static final String	CYAN_BACKGROUND
static final String	DIM
static final String	GREEN
static final String	GREEN_BACKGROUND
static final String	ITALIC
static final String	PURPLE
static final String	PURPLE_BACKGROUND
static final String	RED
static final String	RED_BACKGROUND
static final String	RESET
static final String	UNDERLINED
static final String	WHITE
static final String	WHITE_BACKGROUND
static final String	YELLOW
static final String	YELLOW_BACKGROUND

Method Summary

Modifier and Type	Method	Description
static @NotNull String	black(String text)
static @NotNull String	blackBg(String text)
static @NotNull String	blue(String text)
static @NotNull String	blueBg(String text)
static @NotNull String	bold(String text)
static String	color(String text, String ansiColor)	Sets the color of the given text.
static String	colorBg(String text, String ansiColorBg)	Sets the background color of the given text.
static @NotNull String	cyan(String text)
static @NotNull String	cyanBg(String text)
static String	decorate(String text, String ansiDecoration)	Sets the decoration of the given text.
static @NotNull String	dim(String text)
static @NotNull String	green(String text)
static @NotNull String	greenBg(String text)
static @NotNull String	italic(String text)
static @NotNull String	purple(String text)
static @NotNull String	purpleBg(String text)
static @NotNull String	red(String text)
static @NotNull String	redBg(String text)
static @NotNull String	reset(String text)
static String	strip(String text)	Removes all ANSI escape codes from a given text.
static Color	toColor(String ansiColor)
static @NotNull String	underline(String text)
static @NotNull String	white(String text)
static @NotNull String	whiteBg(String text)
static @NotNull String	yellow(String text)
static @NotNull String	yellowBg(String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RESET

public static final String RESET

See Also:

• Constant Field Values

BLACK

public static final String BLACK

See Also:

• Constant Field Values

RED

public static final String RED

See Also:

• Constant Field Values

GREEN

public static final String GREEN

See Also:

• Constant Field Values

YELLOW

public static final String YELLOW

See Also:

• Constant Field Values

BLUE

public static final String BLUE

See Also:

• Constant Field Values

PURPLE

public static final String PURPLE

See Also:

• Constant Field Values

CYAN

public static final String CYAN

See Also:

• Constant Field Values

WHITE

public static final String WHITE

See Also:

• Constant Field Values

BLACK_BACKGROUND

public static final String BLACK_BACKGROUND

See Also:

• Constant Field Values

RED_BACKGROUND

public static final String RED_BACKGROUND

See Also:

• Constant Field Values

GREEN_BACKGROUND

public static final String GREEN_BACKGROUND

See Also:

• Constant Field Values

YELLOW_BACKGROUND

public static final String YELLOW_BACKGROUND

See Also:

• Constant Field Values

BLUE_BACKGROUND

public static final String BLUE_BACKGROUND

See Also:

• Constant Field Values

PURPLE_BACKGROUND

public static final String PURPLE_BACKGROUND

See Also:

• Constant Field Values

CYAN_BACKGROUND

public static final String CYAN_BACKGROUND

See Also:

• Constant Field Values

WHITE_BACKGROUND

public static final String WHITE_BACKGROUND

See Also:

• Constant Field Values

BOLD

public static final String BOLD

See Also:

• Constant Field Values

DIM

public static final String DIM

See Also:

• Constant Field Values

ITALIC

public static final String ITALIC

See Also:

• Constant Field Values

UNDERLINED

public static final String UNDERLINED

See Also:

• Constant Field Values

Method Details

reset

@NotNull
public static @NotNull String reset(String text)

black

@NotNull
public static @NotNull String black(String text)

red

@NotNull
public static @NotNull String red(String text)

green

@NotNull
public static @NotNull String green(String text)

yellow

@NotNull
public static @NotNull String yellow(String text)

blue

@NotNull
public static @NotNull String blue(String text)

purple

@NotNull
public static @NotNull String purple(String text)

cyan

@NotNull
public static @NotNull String cyan(String text)

white

@NotNull
public static @NotNull String white(String text)

color

@Contract("null, _ -> fail; _, null -> fail; !null, !null -> !null")
public static String color(String text,
 String ansiColor)

Sets the color of the given text.

blackBg

@NotNull
public static @NotNull String blackBg(String text)

redBg

@NotNull
public static @NotNull String redBg(String text)

greenBg

@NotNull
public static @NotNull String greenBg(String text)

yellowBg

@NotNull
public static @NotNull String yellowBg(String text)

blueBg

@NotNull
public static @NotNull String blueBg(String text)

purpleBg

@NotNull
public static @NotNull String purpleBg(String text)

cyanBg

@NotNull
public static @NotNull String cyanBg(String text)

whiteBg

@NotNull
public static @NotNull String whiteBg(String text)

colorBg

@Contract("null, _ -> fail; _, null -> fail; !null, !null -> !null")
public static String colorBg(String text,
 String ansiColorBg)

Sets the background color of the given text.

bold

@NotNull
public static @NotNull String bold(String text)

dim

@NotNull
public static @NotNull String dim(String text)

italic

@NotNull
public static @NotNull String italic(String text)

underline

@NotNull
public static @NotNull String underline(String text)

decorate

@Contract("null, _ -> fail; _, null -> fail; !null, !null -> !null")
public static String decorate(String text,
 String ansiDecoration)

Sets the decoration of the given text.

strip

@Contract("null -> fail; !null -> !null")
public static String strip(String text)

Removes all ANSI escape codes from a given text.

toColor

public static Color toColor(String ansiColor)