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

public final Enum StyleCode

extends Enum<StyleCode>
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 text styling (like italic, underline, etc.).
Since
1.0.0

Field Summary

Modifier and TypeField and Description
public static final StyleCode
BOLD

private final String
code

public static final StyleCode
DIM

public static final StyleCode
DOUBLE_UNDERLINE

public static final StyleCode
INVISIBLE_TEXT

public static final StyleCode
ITALIC

public static final StyleCode
RESET

public static final StyleCode
REVERSE_VIDEO

public static final StyleCode
STRIKETHROUGH

public static final StyleCode
UNDERLINE

Constructor Summary

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

Constructs a StyleCode 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.

Returns the ANSI code itself, making it easy to use in print statements.

public String
toString()

Overrides java.lang.Enum.toString.

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

public static StyleCode
valueOf(String name)

public static StyleCode[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

BOLDback to summary
public static final StyleCode BOLD
codeback to summary
private final String code
DIMback to summary
public static final StyleCode DIM
DOUBLE_UNDERLINEback to summary
public static final StyleCode DOUBLE_UNDERLINE
INVISIBLE_TEXTback to summary
public static final StyleCode INVISIBLE_TEXT
ITALICback to summary
public static final StyleCode ITALIC
RESETback to summary
public static final StyleCode RESET
REVERSE_VIDEOback to summary
public static final StyleCode REVERSE_VIDEO
STRIKETHROUGHback to summary
public static final StyleCode STRIKETHROUGH
UNDERLINEback to summary
public static final StyleCode UNDERLINE

Constructor Detail

StyleCodeback to summary
private StyleCode(String code)

Constructs a StyleCode 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.

Returns the ANSI code itself, making it easy to use in print statements.

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