com.applitools.eyes.logging

Enum TraceLevel

java.lang.Object

java.lang.Enum<TraceLevel>

com.applitools.eyes.logging.TraceLevel

All Implemented Interfaces:

Serializable, Comparable<TraceLevel>

public enum TraceLevel
extends Enum<TraceLevel>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Debug Detailed implementation specific messages helpful for debugging (e.g., enter / exit function, etc.)
Error Indicate an unexpected error conditions that result with a failure to complete an operation.
Info Verbose log messages that are normally not logged
Notice Log messages indicating key steps in a workflow (use as sparsely as possible).
Warn Indicate failures that can be overcome, are expected or are transient (e.g., bad user input, missing user input that can be replaced with a fallback, etc.)

Method Summary

Modifier and Type	Method and Description
boolean	isHigherThan(TraceLevel minLevel) Checks if this level is high enough for logging.
static TraceLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static TraceLevel[]	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

Debug

public static final TraceLevel Debug

Detailed implementation specific messages helpful for debugging (e.g., enter / exit function, etc.)

Info

public static final TraceLevel Info

Verbose log messages that are normally not logged

Notice

public static final TraceLevel Notice

Log messages indicating key steps in a workflow (use as sparsely as possible).

Warn

public static final TraceLevel Warn

Indicate failures that can be overcome, are expected or are transient (e.g., bad user input, missing user input that can be replaced with a fallback, etc.)

Error

public static final TraceLevel Error

Indicate an unexpected error conditions that result with a failure to complete an operation.

Method Detail

values

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

Returns:

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

valueOf

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

isHigherThan

public boolean isHigherThan(TraceLevel minLevel)

Checks if this level is high enough for logging.

Parameters:

minLevel - The minimum level required for logging.