hm.binkley.util.logging

Enum Level

java.lang.Object

java.lang.Enum<Level>

hm.binkley.util.logging.Level

All Implemented Interfaces:

Serializable, Comparable<Level>

public enum Level
extends Enum<Level>

Level inverts calls to SLF4J providing an object for methods corresponding to each logging level.

Author:

B. K. Oxley (binkley)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEBUG All log calls are at the DEBUG level.
ERROR All log calls are at the ERROR level.
INFO All log calls are at the INFO level.
NONE All log calls are ignored.
TRACE All log calls are at the TRACE level.
WARN All log calls are at the WARN level.

Method Summary

Modifier and Type	Method and Description
abstract boolean	isEnabled(org.slf4j.Logger logger) Is the logger instance enabled for this level?
abstract boolean	isEnabled(org.slf4j.Logger logger, org.slf4j.Marker marker) Similar to isEnabled(Logger) method except that the marker data is also taken into account.
abstract void	log(org.slf4j.Logger logger, org.slf4j.Marker marker, String msg) Log a message with the specific Marker at this level.
abstract void	log(org.slf4j.Logger logger, org.slf4j.Marker marker, String format, Object... argArray) This method is similar to log(Logger, String, Object...) method except that the marker data is also taken into consideration.
abstract void	log(org.slf4j.Logger logger, org.slf4j.Marker marker, String format, Object arg) This method is similar to log(Logger, String, Object) method except that the marker data is also taken into consideration.
abstract void	log(org.slf4j.Logger logger, org.slf4j.Marker marker, String format, Object arg1, Object arg2) This method is similar to log(Logger, String, Object, Object) method except that the marker data is also taken into consideration.
abstract void	log(org.slf4j.Logger logger, org.slf4j.Marker marker, String msg, Throwable t) This method is similar to log(Logger, String, Throwable) method except that the marker data is also taken into consideration.
abstract void	log(org.slf4j.Logger logger, String msg) Log a message at this level.
abstract void	log(org.slf4j.Logger logger, String format, Object... arguments) Log a message at this level according to the specified format and arguments.
abstract void	log(org.slf4j.Logger logger, String format, Object arg) Log a message at this level according to the specified format and argument.
abstract void	log(org.slf4j.Logger logger, String format, Object arg1, Object arg2) Log a message at this level according to the specified format and arguments.
abstract void	log(org.slf4j.Logger logger, String msg, Throwable t) Log an exception (throwable) at this level with an accompanying message.
static Level	valueOf(String name) Returns the enum constant of this type with the specified name.
static Level[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Level NONE

All log calls are ignored.

TRACE

public static final Level TRACE

All log calls are at the TRACE level.

DEBUG

public static final Level DEBUG

All log calls are at the DEBUG level.

INFO

public static final Level INFO

All log calls are at the INFO level.

WARN

public static final Level WARN

All log calls are at the WARN level.

ERROR

public static final Level ERROR

All log calls are at the ERROR level.

Method Detail

values

public static Level[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Level c : Level.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Level valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isEnabled

public abstract boolean isEnabled(org.slf4j.Logger logger)

Is the logger instance enabled for this level?

Returns:

True if this Logger is enabled for this level, false otherwise.

log

public abstract void log(org.slf4j.Logger logger,
                         String msg)

Log a message at this level.

Parameters:

msg - the message string to be logged

log

public abstract void log(org.slf4j.Logger logger,
                         String format,
                         Object arg)

Log a message at this level according to the specified format and argument.

This form avoids superfluous object creation when the logger is disabled for this level.

Parameters:

format - the format string

arg - the argument

log

public abstract void log(org.slf4j.Logger logger,
                         String format,
                         Object arg1,
                         Object arg2)

Log a message at this level according to the specified format and arguments.

This form avoids superfluous object creation when the logger is disabled for this level.

Parameters:

format - the format string

arg1 - the first argument

arg2 - the second argument

log

public abstract void log(org.slf4j.Logger logger,
                         String format,
                         Object... arguments)

Log a message at this level according to the specified format and arguments.

This form avoids superfluous string concatenation when the logger is disabled for this level. However, this variant incurs the hidden (and relatively small) cost of creating an Object[] before invoking the method, even if this logger is disabled for this level. The variants taking one and two arguments exist solely in order to avoid this hidden cost.

Parameters:

format - the format string

arguments - a list of 3 or more arguments

log

public abstract void log(org.slf4j.Logger logger,
                         String msg,
                         Throwable t)

Log an exception (throwable) at this level with an accompanying message.

Parameters:

msg - the message accompanying the exception

t - the exception (throwable) to log

isEnabled

public abstract boolean isEnabled(org.slf4j.Logger logger,
                                  org.slf4j.Marker marker)

Similar to isEnabled(Logger) method except that the marker data is also taken into account.

Parameters:

marker - The marker data to take into consideration

Returns:

True if this Logger is enabled for this level, false otherwise.

log

public abstract void log(org.slf4j.Logger logger,
                         org.slf4j.Marker marker,
                         String msg)

Log a message with the specific Marker at this level.

Parameters:

marker - the marker data specific to this log statement

msg - the message string to be logged

log

public abstract void log(org.slf4j.Logger logger,
                         org.slf4j.Marker marker,
                         String format,
                         Object arg)

This method is similar to log(Logger, String, Object) method except that the marker data is also taken into consideration.

Parameters:

marker - the marker data specific to this log statement

format - the format string

arg - the argument

log

public abstract void log(org.slf4j.Logger logger,
                         org.slf4j.Marker marker,
                         String format,
                         Object arg1,
                         Object arg2)

This method is similar to log(Logger, String, Object, Object) method except that the marker data is also taken into consideration.

Parameters:

marker - the marker data specific to this log statement

format - the format string

arg1 - the first argument

arg2 - the second argument

log

public abstract void log(org.slf4j.Logger logger,
                         org.slf4j.Marker marker,
                         String format,
                         Object... argArray)

This method is similar to log(Logger, String, Object...) method except that the marker data is also taken into consideration.

Parameters:

marker - the marker data specific to this log statement

format - the format string

argArray - an array of arguments

log

public abstract void log(org.slf4j.Logger logger,
                         org.slf4j.Marker marker,
                         String msg,
                         Throwable t)

This method is similar to log(Logger, String, Throwable) method except that the marker data is also taken into consideration.

Parameters:

marker - the marker data specific to this log statement

msg - the message accompanying the exception

t - the exception (throwable) to log