Package de.linusdev.lutils.ansi.sgr

Class SGR

java.lang.Object

de.linusdev.lutils.ansi.sgr.SGR

public class SGR
extends Object

Select Graphic Rendition for Consoles. This class can construct control sequences to set display attributes of consoles and terminals.

Example usage:

SGR sgr = new SGR(SGRParameters.FOREGROUND_RED);
 System.out.println(sgr.construct() + "Some text in red." + SGR.reset());
 System.out.println("Normal text.")

This will give the following output:

  Some text in red.
 Normal text

See Also:

• Wikipedia

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull String	RESET_CONSTRUCTED
static final String	SGR_END_CODE
static final String	SGR_PARAMETER_DELIMITER
static final String	SGR_START_CODE

Constructor Summary

Constructors

Constructor	Description
SGR()	same as SGR(String) , with the delimiter SGR_PARAMETER_DELIMITER.
SGR(@NotNull SGRParameter sgrParam, @NotNull String @NotNull ... params)	same as SGR(String, SGRParameter, String[]), with the delimiter SGR_PARAMETER_DELIMITER.
SGR(@NotNull String delimiter)
SGR(@NotNull String delimiter, @NotNull SGRParameter sgrParam, @NotNull String @NotNull ... params)

Method Summary

Modifier and Type	Method	Description
SGR	add(@NotNull SGRParameter sgrParam, @NotNull String @NotNull ... params)	Adds given SGRParameter to this SGR.
@NotNull String	construct()	Constructs the control sequence.
static @NotNull String	reset()

Methods inherited from class java.lang.Object

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

Field Details

SGR_START_CODE

public static final String SGR_START_CODE

See Also:

• Constant Field Values

SGR_PARAMETER_DELIMITER

public static final String SGR_PARAMETER_DELIMITER

See Also:

• Constant Field Values

SGR_END_CODE

public static final String SGR_END_CODE

See Also:

• Constant Field Values

RESET_CONSTRUCTED

@NotNull
public static final @NotNull String RESET_CONSTRUCTED

Constructor Details

SGR

public SGR(@NotNull
 @NotNull String delimiter)

Parameters:

delimiter - delimiter used to seperated arguments.

SGR

public SGR()

same as SGR(String) , with the delimiter SGR_PARAMETER_DELIMITER.

SGR

public SGR(@NotNull
 @NotNull String delimiter,
 @NotNull
 @NotNull SGRParameter sgrParam,
 @NotNull
 @NotNull String @NotNull ... params)

Parameters:

delimiter - delimiter used to seperated arguments.

sgrParam - first SGRParameter

params - parameters for sgrParam

SGR

public SGR(@NotNull
 @NotNull SGRParameter sgrParam,
 @NotNull
 @NotNull String @NotNull ... params)

same as SGR(String, SGRParameter, String[]), with the delimiter SGR_PARAMETER_DELIMITER.

Method Details

reset

@NotNull
public static @NotNull String reset()

add

public SGR add(@NotNull
 @NotNull SGRParameter sgrParam,
 @NotNull
 @NotNull String @NotNull ... params)

Adds given SGRParameter to this SGR.

Parameters:

sgrParam - SGRParameter to add.

params - parameters for sgrParam

Returns:

this

construct

@NotNull
public @NotNull String construct()

Constructs the control sequence.

Returns:

the constructed control sequence