Package org.gradle.api.logging.configuration

Enum WarningMode

java.lang.Object

java.lang.Enum<WarningMode>

org.gradle.api.logging.configuration.WarningMode

All Implemented Interfaces:

Serializable, Comparable<WarningMode>, java.lang.constant.Constable

public enum WarningMode
extends Enum<WarningMode>

Specifies the warning mode a user wants to see.

Since:

4.5

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
All	Show all warnings.
Fail	Show all warnings and fail the build if any warning present
None	No deprecation warnings at all.
Summary	Display a summary at the end of the build instead of rendering all warnings into the console output.

Method Summary

Modifier and Type	Method	Description
boolean	shouldDisplayMessages()	Indicates whether deprecation messages are to be printed in-line
static WarningMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WarningMode[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

All

public static final WarningMode All

Show all warnings.

Summary

public static final WarningMode Summary

Display a summary at the end of the build instead of rendering all warnings into the console output.

None

public static final WarningMode None

No deprecation warnings at all.

Fail

public static final WarningMode Fail

Show all warnings and fail the build if any warning present

Since:

5.6

Method Details

values

public static WarningMode[] values()

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

Returns:

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

valueOf

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

shouldDisplayMessages

public boolean shouldDisplayMessages()

Indicates whether deprecation messages are to be printed in-line

Returns:

true if messages are to be printed, false otherwise

Since:

5.6