org.peace_tools.generic
Enum Log.LogLevel

java.lang.Object
  java.lang.Enum<Log.LogLevel>
      org.peace_tools.generic.Log.LogLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Log.LogLevel>

Enclosing class:

Log

public static enum Log.LogLevel
extends java.lang.Enum<Log.LogLevel>

This enumeration provides a convenient mechanism for referring to different error levels when generating logs. The error levels are interpreted in different manners as documented with each enumeration. The user typically has the option to control the level of logging that the user desires. Typically DEBUG and INFO levels are not logged by default.

Enum Constant Summary

ERROR
This log level value must be used to generate error messages that report failure of operations and provide additional information regarding failure status.

INFO
This is an unimportant log entry that is typically used to provide additional information to the user.

NOTICE
This is a reasonably important log entry that is typically used to provide additional information to the user.

WARNING
This log level value must be used to generate warning messages that indicate impeding problems to the user.

Method Summary

static Log.LogLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Log.LogLevel[]	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

INFO

public static final Log.LogLevel INFO

This is an unimportant log entry that is typically used to provide additional information to the user.

NOTICE

public static final Log.LogLevel NOTICE

This is a reasonably important log entry that is typically used to provide additional information to the user. This level is used to provide some useful information to the user (such as timings or Job completion notices) that does not impact the overall operation of the system.

WARNING

public static final Log.LogLevel WARNING

This log level value must be used to generate warning messages that indicate impeding problems to the user. Messages such as loss of network connectivity or reduced availability of memory fall into this category.

ERROR

public static final Log.LogLevel ERROR

This log level value must be used to generate error messages that report failure of operations and provide additional information regarding failure status.

Method Detail

values

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

Returns:

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

valueOf

public static Log.LogLevel valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null