Package com.xwiki.admintools.jobs

Enum JobResultLevel

java.lang.Object

java.lang.Enum<JobResultLevel>

com.xwiki.admintools.jobs.JobResultLevel

All Implemented Interfaces:

Serializable, Comparable<JobResultLevel>

@Unstable
public enum JobResultLevel
extends Enum<JobResultLevel>

Represents the severity level of a job, where "INFO" is for informative results, "WARN" for warnings, "ERROR" for severe issues and "FAIL" for job failures.

Since:

1.0

Version:

$Id$

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR	Used to mark a JobResultLevel as an error.
FAIL	This is used to mark a job failure.
INFO	Used to mark a JobResultLevel as informative.
WARN	Used to mark a JobResultLevel as a warning.

Method Summary

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

FAIL

public static final JobResultLevel FAIL

This is used to mark a job failure.

Since:

1.3

ERROR

public static final JobResultLevel ERROR

Used to mark a JobResultLevel as an error.

WARN

public static final JobResultLevel WARN

Used to mark a JobResultLevel as a warning.

INFO

public static final JobResultLevel INFO

Used to mark a JobResultLevel as informative.

Method Detail

values

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

Returns:

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

valueOf

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