org.apache.log
Class Priority

java.lang.Object
  org.apache.log.Priority

All Implemented Interfaces:

Serializable

public final class Priority
extends Object
implements Serializable

Class representing and holding constants for priority.

Author:

Peter Donald

See Also:

Serialized Form

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.
private String	m_name
private int	m_priority
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.

Constructor Summary

private

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

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.
private Object	readResolve() Helper method that replaces deserialized object with correct singleton.
String	toString() Overidden string to display Priority in human readable form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEBUG

public static final Priority DEBUG

Developer orientated messages, usually used during development of product.

INFO

public static final Priority INFO

Useful information messages such as state changes, client connection, user login etc.

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.

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.

NONE

public static final Priority NONE

Do not log anything.

m_name

private final String m_name

m_priority

private final int m_priority

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

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

toString

public String toString()

Overidden string to display Priority in human readable form.

Overrides:

toString in class Object

Returns:

the string describing priority

getValue

public int getValue()

Get numerical value associated with priority.

Returns:

the numerical value

getName

public String getName()

Get name of priority.

Returns:

the priorities name

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