Package org.gradle.api.logging.configuration

Enum ConsoleOutput

java.lang.Object

java.lang.Enum<ConsoleOutput>

org.gradle.api.logging.configuration.ConsoleOutput

All Implemented Interfaces:

Serializable, Comparable<ConsoleOutput>

public enum ConsoleOutput
extends Enum<ConsoleOutput>

Specifies how to treat color and dynamic console output.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Auto	Enable color and rich output when the current process is attached to a console, disable when not attached to a console.
Plain	Disable all color and rich output.
Rich	Enable color and rich output, regardless of whether the current process is attached to a console or not.
Verbose	Enable color and rich output like Rich, but output more detailed message.

Method Summary

Modifier and Type	Method	Description
static ConsoleOutput	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConsoleOutput[]	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

Plain

public static final ConsoleOutput Plain

Disable all color and rich output. Generate plain text only.

Auto

public static final ConsoleOutput Auto

Enable color and rich output when the current process is attached to a console, disable when not attached to a console.

Rich

public static final ConsoleOutput Rich

Enable color and rich output, regardless of whether the current process is attached to a console or not. When not attached to a console, the color and rich output is encoded using ANSI control characters.

Verbose

@Incubating
public static final ConsoleOutput Verbose

Enable color and rich output like Rich, but output more detailed message.

Since:

4.3

Method Detail

values

public static ConsoleOutput[] 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 (ConsoleOutput c : ConsoleOutput.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConsoleOutput 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