org.ops4j.pax.logging.spi

Interface PaxLevel

public interface PaxLevel

Framework library agnostic representation of logging level. There are two uses of level concept:

• detail level or importance of logging event
• threshold of the logging service, appender or destination, that allows to process or reject logging events with some level

Terms like higher or lower may be confusing at first glance. Each framework may use different numerical levels than other. Syslog and LogService use higher numerical values for less important logging events. Log4J1 and java.util.logging use higher numerical values for more important events.

This interface is based on Log4J1 and:

• the higher value (numerically) the more important the event is (higher severity)
• INFO is higher than DEBUG
• when used as threshold, PaxLevel=INFO rejects events with level=DEBUG and level=TRACE.
• also, the higher the threshold the more events are rejected (less are processed).

Method Summary

Modifier and Type	Method and Description
int	getSyslogEquivalent() Return the syslog equivalent of this priority as an integer.
boolean	isGreaterOrEqual(PaxLevel r) Returns true if this level has a higher or equal level (is more important, has bigger severity) than the level passed as argument, false otherwise.
int	toInt() Returns the integer representation of this level.

Method Detail

isGreaterOrEqual

boolean isGreaterOrEqual(PaxLevel r)

Returns true if this level has a higher or equal level (is more important, has bigger severity) than the level passed as argument, false otherwise.

Parameters:

r - the PaxLevel to compare with.

Returns:

true if this level has a higher or equal level than the level passed as argument, false otherwise.

toInt

int toInt()

Returns the integer representation of this level. The higher the numerical value, the more important is the logging event with given level. When used as threshold, the higher the numerical value, the more events are rejected (i.e., high threshold means process only more important events).

Returns:

the integer representation of this level. The value is not logging-framework specific - only values from PaxLogger (e.g., PaxLogger.LEVEL_INFO) are returned

getSyslogEquivalent

int getSyslogEquivalent()

Return the syslog equivalent of this priority as an integer. In Syslog (https://en.wikipedia.org/wiki/Syslog#Severity_level), higher numerical values indicate less important logging events.

Returns:

the syslog equivalent of this priority as an integer.