Class AnsiOutput

java.lang.Object

org.springframework.boot.ansi.AnsiOutput

public abstract class AnsiOutput
extends Object

Generates ANSI encoded output, automatically attempting to detect if the terminal supports ANSI.

Since:

1.0.0

Author:

Phillip Webb, Yong-Hyun Kim

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AnsiOutput.Enabled	Possible values to pass to setEnabled(org.springframework.boot.ansi.AnsiOutput.Enabled).

Constructor Summary

Constructors

Constructor	Description
AnsiOutput()

Method Summary

Modifier and Type	Method	Description
static String	encode(AnsiElement element)	Encode a single AnsiElement if output is enabled.
static AnsiOutput.Enabled	getEnabled()	Returns if ANSI output is enabled
static void	setConsoleAvailable(@Nullable Boolean consoleAvailable)	Sets if the System.console() is known to be available.
static void	setEnabled(AnsiOutput.Enabled enabled)	Sets if ANSI output is enabled.
static String	toString(Object... elements)	Create a new ANSI string from the specified elements.

Methods inherited from class java.lang.Object

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

Constructor Details

AnsiOutput

public AnsiOutput()

Method Details

setEnabled

public static void setEnabled(AnsiOutput.Enabled enabled)

Sets if ANSI output is enabled.

Parameters:

enabled - if ANSI is enabled, disabled or detected

getEnabled

public static AnsiOutput.Enabled getEnabled()

Returns if ANSI output is enabled

Returns:

if ANSI enabled, disabled or detected

setConsoleAvailable

public static void setConsoleAvailable(@Nullable Boolean consoleAvailable)

Sets if the System.console() is known to be available.

Parameters:

consoleAvailable - if the console is known to be available or null to use standard detection logic.

encode

public static String encode(AnsiElement element)

Encode a single AnsiElement if output is enabled.

Parameters:

element - the element to encode

Returns:

the encoded element or an empty string

toString

public static String toString(Object... elements)

Create a new ANSI string from the specified elements. Any AnsiElements will be encoded as required.

Parameters:

elements - the elements to encode

Returns:

a string of the encoded elements