org.apache.log

Class Priority

public final class Priority extends Object implements Serializable

Class representing and holding constants for priority.

Author: Peter Donald

Field Summary
static PriorityDEBUG
Developer orientated messages, usually used during development of product.
static PriorityERROR
A problem has occurred but it is not fatal.
static PriorityFATAL_ERROR
Something caused whole system to fail.
static PriorityINFO
Useful information messages such as state changes, client connection, user login etc.
Stringm_name
intm_priority
static PriorityNONE
Do not log anything.
static PriorityWARN
A problem or conflict has occurred but it may be recoverable, then again it could be the start of the system failing.
Constructor Summary
Priority(String name, int priority)
Private Constructor to block instantiation outside class.
Method Summary
StringgetName()
Get name of priority.
static PrioritygetPriorityForName(String priority)
Retrieve a Priority object for the name parameter.
intgetValue()
Get numerical value associated with priority.
booleanisGreater(Priority other)
Test whether this priority is greater than other priority.
booleanisLower(Priority other)
Test whether this priority is lower than other priority.
booleanisLowerOrEqual(Priority other)
Test whether this priority is lower or equal to other priority.
ObjectreadResolve()
Helper method that replaces deserialized object with correct singleton.
StringtoString()
Overidden string to display Priority in human readable form.

Field Detail

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.

m_name

private final String m_name

m_priority

private final int m_priority

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.

Constructor Detail

Priority

private Priority(String name, int priority)
Private Constructor to block instantiation outside class.

Parameters: name the string name of priority priority the numerical code of priority

Method Detail

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

readResolve

private Object readResolve()
Helper method that replaces deserialized object with correct singleton.

Returns: the singleton version of object

toString

public String toString()
Overidden string to display Priority in human readable form.

Returns: the string describing priority