com.googlecode.kevinarpe.papaya.logging.slf4j

Interface LoggerService

All Known Implementing Classes:

LoggerServiceImpl

@ThreadSafe
public interface LoggerService

Strangely, SLF4J does not provide an interface method to log by level parameter, e.g., "info" or "error". This tiny interface enhances SLF4J's Logger.

ThreadSafe? Implementations must be thread-safe.

Author:

Kevin Connor ARPE (kevinarpe@gmail.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_THROWABLE_MESSAGE

Method Summary

Modifier and Type	Method and Description
void	formatThenLog(org.slf4j.Logger logger, LoggerLevel loggerLevel, String format, Object... argArr) This is a convenience method to call MessageFormatter.format(String, Object...), then pass the result to log(Logger, LoggerLevel, String).
void	formatThenLogThrowable(org.slf4j.Logger logger, LoggerLevel loggerLevel, IncludeStackTrace includeStackTrace, Throwable throwable, String format, Object... argArr) This is a convenience method to call MessageFormatter.format(String, Object...), then pass the result to logThrowable(Logger, LoggerLevel, IncludeStackTrace, Throwable, String).
void	log(org.slf4j.Logger logger, LoggerLevel loggerLevel, String message) Important: The message is not formatted before logging.
void	logThrowable(org.slf4j.Logger logger, LoggerLevel loggerLevel, IncludeStackTrace includeStackTrace, Throwable throwable, String message) Logs an exception ("throwable"), but provides control over inclusion of stack trace.
default void	logThrowableWithDefaultMessage(org.slf4j.Logger logger, LoggerLevel loggerLevel, IncludeStackTrace includeStackTrace, Throwable throwable) This is a convenience method to call logThrowable(Logger, LoggerLevel, IncludeStackTrace, Throwable, String) where message is DEFAULT_THROWABLE_MESSAGE.

Field Detail

DEFAULT_THROWABLE_MESSAGE

static final String DEFAULT_THROWABLE_MESSAGE

See Also:

Constant Field Values

Method Detail

log

void log(org.slf4j.Logger logger,
         LoggerLevel loggerLevel,
         String message)

Important: The message is not formatted before logging. This is sometimes very useful when you are logging odd text that is also a valid format string, e.g., anything with a percent sign!

Throws:

NullPointerException - if message is null

IllegalArgumentException - if message is empty or only whitespace

formatThenLog

void formatThenLog(org.slf4j.Logger logger,
                   LoggerLevel loggerLevel,
                   String format,
                   Object... argArr)

This is a convenience method to call MessageFormatter.format(String, Object...), then pass the result to log(Logger, LoggerLevel, String).

The result of MessageFormatter.format(...) must not be empty or all whitespace.

logThrowable

void logThrowable(org.slf4j.Logger logger,
                  LoggerLevel loggerLevel,
                  IncludeStackTrace includeStackTrace,
                  Throwable throwable,
                  String message)

Logs an exception ("throwable"), but provides control over inclusion of stack trace. Frequently, only the first instance of a stack trace is useful.

Throws:

NullPointerException - if message is null

IllegalArgumentException - if message is empty or only whitespace

formatThenLogThrowable

void formatThenLogThrowable(org.slf4j.Logger logger,
                            LoggerLevel loggerLevel,
                            IncludeStackTrace includeStackTrace,
                            Throwable throwable,
                            String format,
                            Object... argArr)

This is a convenience method to call MessageFormatter.format(String, Object...), then pass the result to logThrowable(Logger, LoggerLevel, IncludeStackTrace, Throwable, String).

The result of MessageFormatter.format(...) must not be empty or all whitespace.

logThrowableWithDefaultMessage

default void logThrowableWithDefaultMessage(org.slf4j.Logger logger,
                                            LoggerLevel loggerLevel,
                                            IncludeStackTrace includeStackTrace,
                                            Throwable throwable)

This is a convenience method to call logThrowable(Logger, LoggerLevel, IncludeStackTrace, Throwable, String) where message is DEFAULT_THROWABLE_MESSAGE.