org.springframework.boot.ansi

Enum AnsiOutput.Enabled

java.lang.Object

java.lang.Enum<AnsiOutput.Enabled>

org.springframework.boot.ansi.AnsiOutput.Enabled

All Implemented Interfaces:

Serializable, Comparable<AnsiOutput.Enabled>

Enclosing class:

AnsiOutput

public static enum AnsiOutput.Enabled
extends Enum<AnsiOutput.Enabled>

Possible values to pass to AnsiOutput.setEnabled(org.springframework.boot.ansi.AnsiOutput.Enabled). Determines when to output ANSI escape sequences for coloring application output.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Enable ANSI-colored output
DETECT Try to detect whether ANSI coloring capabilities are available.
NEVER Disable ANSI-colored output

Method Summary

Methods

Modifier and Type	Method and Description
static AnsiOutput.Enabled	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnsiOutput.Enabled[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DETECT

public static final AnsiOutput.Enabled DETECT

Try to detect whether ANSI coloring capabilities are available. The default value for AnsiOutput.

ALWAYS

public static final AnsiOutput.Enabled ALWAYS

Enable ANSI-colored output

NEVER

public static final AnsiOutput.Enabled NEVER

Disable ANSI-colored output

Method Detail

values

public static AnsiOutput.Enabled[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AnsiOutput.Enabled c : AnsiOutput.Enabled.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AnsiOutput.Enabled valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null