org.apache.log

Class Priority

Implemented Interfaces:
Serializable

public final class Priority
extends java.lang.Object
implements Serializable

Class representing and holding constants for priority.
Author:
Peter Donald

Field Summary

static Priority
DEBUG
Developer orientated messages, usually used during development of product.
static Priority
ERROR
A problem has occurred but it is not fatal.
static Priority
FATAL_ERROR
Something caused whole system to fail.
static Priority
INFO
Useful information messages such as state changes, client connection, user login etc.
static Priority
NONE
Do not log anything.
static Priority
WARN
A problem or conflict has occurred but it may be recoverable, then again it could be the start of the system failing.

Method Summary

String
getName()
Get name of priority.
static Priority
getPriorityForName(String priority)
Retrieve a Priority object for the name parameter.
int
getValue()
Get numerical value associated with priority.
boolean
isGreater(Priority other)
Test whether this priority is greater than other priority.
boolean
isLower(Priority other)
Test whether this priority is lower than other priority.
boolean
isLowerOrEqual(Priority other)
Test whether this priority is lower or equal to other priority.
String
toString()
Overidden string to display Priority in human readable form.

Field Details

DEBUG

public static final Priority DEBUG
Developer orientated messages, usually used during development of product.

ERROR

public static final Priority ERROR
A problem has occurred but it is not fatal. The system will still function.

FATAL_ERROR

public static final Priority FATAL_ERROR
Something caused whole system to fail. This indicates that an administrator should restart the system and try to fix the problem that caused the failure.

INFO

public static final Priority INFO
Useful information messages such as state changes, client connection, user login etc.

NONE

public static final Priority NONE
Do not log anything.

WARN

public static final Priority WARN
A problem or conflict has occurred but it may be recoverable, then again it could be the start of the system failing.

Method Details

getName

public String getName()
Get name of priority.
Returns:
the priorities name

getPriorityForName

public static Priority getPriorityForName(String priority)
Retrieve a Priority object for the name parameter.
Parameters:
priority - the priority name
Returns:
the Priority for name

getValue

public int getValue()
Get numerical value associated with priority.
Returns:
the numerical value

isGreater

public boolean isGreater(Priority other)
Test whether this priority is greater than other priority.
Parameters:
other - the other Priority
Returns:
TRUE if the priority is greater else FALSE

isLower

public boolean isLower(Priority other)
Test whether this priority is lower than other priority.
Parameters:
other - the other Priority
Returns:
TRUE if the priority is lower else FALSE

isLowerOrEqual

public boolean isLowerOrEqual(Priority other)
Test whether this priority is lower or equal to other priority.
Parameters:
other - the other Priority
Returns:
TRUE if the priority is lower or equal else FALSE

toString

public String toString()
Overidden string to display Priority in human readable form.
Returns:
the string describing priority