Top Description Fields Constructors Methods
io.github.kusoroadeolu.clique.style

public final Enum ColorCode

extends Enum<ColorCode>
implements AnsiCode
Class Inheritance
All Implemented Interfaces
io.github.kusoroadeolu.clique.spi.AnsiCode
Annotations
@Stable
since:3.2.0
Imports
io.github.kusoroadeolu.clique.internal.documentation.Stable, io.github.kusoroadeolu.clique.spi.AnsiCode
Represents ANSI escape codes for basic text colors.
Since
1.0.0

Field Summary

Modifier and TypeField and Description
public static final ColorCode
BLACK

public static final ColorCode
BLUE

public static final ColorCode
BRIGHT_BLACK

public static final ColorCode
BRIGHT_BLUE

public static final ColorCode
BRIGHT_CYAN

public static final ColorCode
BRIGHT_GREEN

public static final ColorCode
BRIGHT_MAGENTA

public static final ColorCode
BRIGHT_RED

public static final ColorCode
BRIGHT_WHITE

public static final ColorCode
BRIGHT_YELLOW

private final String
code

public static final ColorCode
CYAN

public static final ColorCode
GREEN

public static final ColorCode
MAGENTA

public static final ColorCode
RED

public static final ColorCode
WHITE

public static final ColorCode
YELLOW

Constructor Summary

AccessConstructor and Description
private
ColorCode(String
The ANSI escape code string.
code)

Constructs a ColorCode enum value.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

The ANSI escape code string.
ansiSequence()

Implements io.github.kusoroadeolu.clique.spi.AnsiCode.ansiSequence.

Overrides the toString method to return the ANSI code itself, which makes using the enum simpler when printing color.

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static ColorCode
valueOf(String name)

public static ColorCode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

BLACKback to summary
public static final ColorCode BLACK
BLUEback to summary
public static final ColorCode BLUE
BRIGHT_BLACKback to summary
public static final ColorCode BRIGHT_BLACK
BRIGHT_BLUEback to summary
public static final ColorCode BRIGHT_BLUE
BRIGHT_CYANback to summary
public static final ColorCode BRIGHT_CYAN
BRIGHT_GREENback to summary
public static final ColorCode BRIGHT_GREEN
BRIGHT_MAGENTAback to summary
public static final ColorCode BRIGHT_MAGENTA
BRIGHT_REDback to summary
public static final ColorCode BRIGHT_RED
BRIGHT_WHITEback to summary
public static final ColorCode BRIGHT_WHITE
BRIGHT_YELLOWback to summary
public static final ColorCode BRIGHT_YELLOW
codeback to summary
private final String code
CYANback to summary
public static final ColorCode CYAN
GREENback to summary
public static final ColorCode GREEN
MAGENTAback to summary
public static final ColorCode MAGENTA
REDback to summary
public static final ColorCode RED
WHITEback to summary
public static final ColorCode WHITE
YELLOWback to summary
public static final ColorCode YELLOW

Constructor Detail

ColorCodeback to summary
private ColorCode(String code)

Constructs a ColorCode enum value.

Parameters
code:String

The ANSI escape code string.

Method Detail

ansiSequenceback to summary
public String ansiSequence()

Implements io.github.kusoroadeolu.clique.spi.AnsiCode.ansiSequence.

Overrides the toString method to return the ANSI code itself, which makes using the enum simpler when printing color.

Returns:String

The ANSI escape code string.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Annotations
@Override
valueOfback to summary
public static ColorCode valueOf(String name)
valuesback to summary
public static ColorCode[] values()