Module de.bernd_michaely.common.cli.parser

Package de.bernd_michaely.common.cli.parser

Class AnsiColorEscapeCodesUtil

java.lang.Object

de.bernd_michaely.common.cli.parser.AnsiColorEscapeCodesUtil

public class AnsiColorEscapeCodesUtil
extends Object

Utility class providing a few conceptual default string coloring methods (meant for command line application help messages) and a global (static) on/off switch for colored output.

Method Summary

Modifier and Type	Method	Description
static String	formatAsAbstract(String s)	Returns a default color formatting for abstracts.
static String	formatAsColored(String s, AnsiColorEscapeCodes colorFg, boolean bright)	Returns a colored version of the provided string, if coloring is enabled, otherwise the unchanged provided string.
static String	formatAsExample(String s)	Returns a default color formatting for examples.
static String	formatAsHeader(String s)	Returns a default color formatting for headers.
static String	formatAsOption(String s)	Returns a default color formatting for options.
static boolean	isColoringEnabled()	Returns true, iff coloring is globally enabled.
static void	setColoringEnabled(boolean enabled)	Set coloring globally enabled.

Methods inherited from class java.lang.Object

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

Method Detail

isColoringEnabled

public static boolean isColoringEnabled()

Returns true, iff coloring is globally enabled. Coloring is enabled by default.

Returns:

true, iff coloring is globally enabled

setColoringEnabled

public static void setColoringEnabled(boolean enabled)

Set coloring globally enabled. Coloring is enabled by default.

Parameters:

enabled - true to enable

formatAsColored

public static String formatAsColored(String s,
                                     AnsiColorEscapeCodes colorFg,
                                     boolean bright)

Returns a colored version of the provided string, if coloring is enabled, otherwise the unchanged provided string. If the provided string is null, the empty string is returned.

Parameters:

s - the provided string

colorFg - the foreground color (null for no coloring)

bright - true for bright color

Returns:

a colored version of the provided string

formatAsHeader

public static String formatAsHeader(String s)

Returns a default color formatting for headers.

Parameters:

s - the provided string

Returns:

a default color formatting for headers

formatAsAbstract

public static String formatAsAbstract(String s)

Returns a default color formatting for abstracts.

Parameters:

s - the provided string

Returns:

a default color formatting for abstracts

formatAsOption

public static String formatAsOption(String s)

Returns a default color formatting for options.

Parameters:

s - the provided string

Returns:

a default color formatting for options

formatAsExample

public static String formatAsExample(String s)

Returns a default color formatting for examples.

Parameters:

s - the provided string

Returns:

a default color formatting for examples