fr.ifremer.isisfish.logging

Enum LogLevel

java.lang.Object

java.lang.Enum<LogLevel>

fr.ifremer.isisfish.logging.LogLevel

All Implemented Interfaces:

Serializable, Comparable<LogLevel>

public enum LogLevel
extends Enum<LogLevel>

abstraction of a log level. a LogLevel is defined by 3 properties :

• his name (given by Enum.name())
• his severity (higher severity is the lower value, be carefull) (given by Enum.ordinal())
• his mask value (given by mask())

The mask value is introduced to make possible some performant search. Using the "1 << ordinal()" idiom is the easiest manner to manage operations of set of LogLevels.

To obtain a LogLevel from his severity, use getLogLevel(int)

Author:

chemit

See Also:

LogLevelUtil, LogLevelUtil.createSet(int, int...), LogLevelUtil.addToSet(int,int), LogLevelUtil.removeFromSet(int,int), LogLevelUtil.getLogLevels(int)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG
ERROR
FATAL
INFO
TRACE
USER
WARN

Method Summary

Methods

Modifier and Type	Method and Description
static LogLevel	getLogLevel(int ordinal)
int	mask()
static LogLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static 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

FATAL

public static final LogLevel FATAL

ERROR

public static final LogLevel ERROR

WARN

public static final LogLevel WARN

INFO

public static final LogLevel INFO

DEBUG

public static final LogLevel DEBUG

TRACE

public static final LogLevel TRACE

USER

public static final LogLevel USER

Method Detail

values

public static 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 (LogLevel c : 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 LogLevel 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

mask

public int mask()

getLogLevel

public static LogLevel getLogLevel(int ordinal)

Parameters:

ordinal - the ordinal of of the level

Returns:

the LogLevel if found, or null.