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

public final Enum BackgroundCode

extends Enum<BackgroundCode>
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
Since
1.0.0

Field Summary

Modifier and TypeField and Description
public static final BackgroundCode
BLACK

public static final BackgroundCode
BLUE

public static final BackgroundCode
BRIGHT_BLACK

public static final BackgroundCode
BRIGHT_BLUE

public static final BackgroundCode
BRIGHT_CYAN

public static final BackgroundCode
BRIGHT_GREEN

public static final BackgroundCode
BRIGHT_MAGENTA

public static final BackgroundCode
BRIGHT_RED

public static final BackgroundCode
BRIGHT_WHITE

public static final BackgroundCode
BRIGHT_YELLOW

private final String
code

public static final BackgroundCode
CYAN

public static final BackgroundCode
GREEN

public static final BackgroundCode
MAGENTA

public static final BackgroundCode
RED

public static final BackgroundCode
WHITE

public static final BackgroundCode
YELLOW

Constructor Summary

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

Constructs a BackgroundCode 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, making it simpler to concatenate with strings.

public String
toString()

Overrides java.lang.Enum.toString.

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

public static BackgroundCode
valueOf(String name)

public static BackgroundCode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

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

Constructor Detail

BackgroundCodeback to summary
private BackgroundCode(String code)

Constructs a BackgroundCode 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, making it simpler to concatenate with strings.

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 BackgroundCode valueOf(String name)
valuesback to summary
public static BackgroundCode[] values()