org.apache.log4j.lf5

Class LogLevel

Implemented Interfaces:
Serializable

public class LogLevel
extends Object
implements Serializable

The LogLevel class defines a set of standard logging levels. The logging Level objects are ordered and are specified by ordered integers. Enabling logging at a given level also enables logging at all higher levels.
Authors:
Michael J. Sikorsky
Robert Shaw
Brent Sprecher
Richard Hurst
Brad Marlborough
See Also:
Serialized Form

Field Summary

static LogLevel
CONFIG
static LogLevel
DEBUG
static LogLevel
ERROR
static LogLevel
FATAL
static LogLevel
FINE
static LogLevel
FINER
static LogLevel
FINEST
static LogLevel
INFO
static LogLevel
SEVERE
static LogLevel
WARN
static LogLevel
WARNING
protected String
_label
protected int
_precedence

Constructor Summary

LogLevel(String label, int precedence)

Method Summary

boolean
encompasses(LogLevel level)
Returns true if the level supplied is encompassed by this level.
boolean
equals(Object o)
static List
getAllDefaultLevels()
static List
getJdk14Levels()
String
getLabel()
Return the Label of the LogLevel.
static List
getLog4JLevels()
static Map
getLogLevelColorMap()
protected int
getPrecedence()
int
hashCode()
static void
register(List logLevels)
static LogLevel
register(LogLevel logLevel)
Registers a used defined LogLevel.
static void
register(LogLevel[] logLevels)
static void
resetLogLevelColorMap()
void
setLogLevelColorMap(LogLevel level, Color color)
String
toString()
static LogLevel
valueOf(String level)
Convert a log level label into a LogLevel object.

Field Details

CONFIG

public static final LogLevel CONFIG

DEBUG

public static final LogLevel DEBUG

ERROR

public static final LogLevel ERROR

FATAL

public static final LogLevel FATAL

FINE

public static final LogLevel FINE

FINER

public static final LogLevel FINER

FINEST

public static final LogLevel FINEST

INFO

public static final LogLevel INFO

SEVERE

public static final LogLevel SEVERE

WARN

public static final LogLevel WARN

WARNING

public static final LogLevel WARNING

_label

protected String _label

_precedence

protected int _precedence

Constructor Details

LogLevel

public LogLevel(String label,
                int precedence)

Method Details

encompasses

public boolean encompasses(LogLevel level)
Returns true if the level supplied is encompassed by this level. For example, LogLevel.SEVERE encompasses no other LogLevels and LogLevel.FINE encompasses all other LogLevels. By definition, a LogLevel encompasses itself.

equals

public boolean equals(Object o)

getAllDefaultLevels

public static List getAllDefaultLevels()

getJdk14Levels

public static List getJdk14Levels()

getLabel

public String getLabel()
Return the Label of the LogLevel.

getLog4JLevels

public static List getLog4JLevels()
Returns:
A List of LogLevel objects that map to log4j Priority objects.

getLogLevelColorMap

public static Map getLogLevelColorMap()

getPrecedence

protected int getPrecedence()

hashCode

public int hashCode()

register

public static void register(List logLevels)

register

public static LogLevel register(LogLevel logLevel)
Registers a used defined LogLevel.
Parameters:
logLevel - The log level to be registered. Cannot be a default LogLevel
Returns:
LogLevel The replaced log level.

register

public static void register(LogLevel[] logLevels)

resetLogLevelColorMap

public static void resetLogLevelColorMap()

setLogLevelColorMap

public void setLogLevelColorMap(LogLevel level,
                                Color color)

toString

public String toString()

valueOf

public static LogLevel valueOf(String level)
            throws LogLevelFormatException
Convert a log level label into a LogLevel object.
Parameters:
level - The label of a level to be converted into a LogLevel.
Returns:
LogLevel The LogLevel with a label equal to level.
Throws:
LogLevelFormatException - Is thrown when the level can not be converted into a LogLevel.

Copyright 2000-2005 Apache Software Foundation.