Package org.atlanmod.commons.log

Interface Logger

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@ThreadSafe
@Immutable
@ParametersAreNullableByDefault
public interface Logger

An object that provides logging operations, filtered by Levels.

Implementations of this interface are expected to be thread-safe, and can be safely accessed by multiple concurrent threads.

Field Summary

Fields

Modifier and Type	Field	Description
static Throwable	NO_EXCEPTION	A throwable representing a logging without exception.
static CharSequence	NO_MESSAGE	A string representing a logging without message.
static Object[]	NO_PARAMS	An empty array representing logging without parameters.

Method Summary

Modifier and Type	Method	Description
default void	debug(CharSequence message)	Logs a message at the DEBUG level.
default void	debug(CharSequence message, Object... params)	Logs a message with parameters at the DEBUG level.
default void	debug(Object obj)	Logs an object at the DEBUG level.
default void	debug(Throwable e)	Logs the stack trace of the given Throwable at the DEBUG level.
default void	debug(Throwable e, CharSequence message)	Logs a message at the DEBUG level including the stack trace of the given Throwable.
default void	debug(Throwable e, CharSequence message, Object... params)	Logs a message with parameters at the DEBUG level including the stack trace of the given Throwable.
default void	error(CharSequence message)	Logs a message at the ERROR level.
default void	error(CharSequence message, Object... params)	Logs a message with parameters at the ERROR level.
default void	error(Object obj)	Logs an object at the ERROR level.
default void	error(Throwable e)	Logs the stack trace of the given Throwable at the ERROR level.
default void	error(Throwable e, CharSequence message)	Logs a message at the ERROR level including the stack trace of the given Throwable.
default void	error(Throwable e, CharSequence message, Object... params)	Logs a message with parameters at the ERROR level including the stack trace of the given Throwable.
default void	info(CharSequence message)	Logs a message at the INFO level.
default void	info(CharSequence message, Object... params)	Logs a message with parameters at the INFO level.
default void	info(Object obj)	Logs an object at the INFO level.
default void	info(Throwable e)	Logs the stack trace of the given Throwable at the INFO level.
default void	info(Throwable e, CharSequence message)	Logs a message at the INFO level including the stack trace of the given Throwable.
default void	info(Throwable e, CharSequence message, Object... params)	Logs a message with parameters at the INFO level including the stack trace of the given Throwable.
default void	log(Level level, CharSequence message)	Logs a message at the given level.
default void	log(Level level, CharSequence message, Object... params)	Logs a message with parameters at the given level.
default void	log(Level level, Object obj)	Logs an object at the given level.
default void	log(Level level, Throwable e)	Logs the stack trace of the given Throwable at the given level.
default void	log(Level level, Throwable e, CharSequence message)	Logs a message at the given level including the stack trace of the given Throwable.
void	log(Level level, Throwable e, CharSequence message, Object... params)	Logs a message with parameters at the given level including the stack trace of the given Throwable.
default void	trace(CharSequence message)	Logs a message at the TRACE level.
default void	trace(CharSequence message, Object... params)	Logs a message with parameters at the TRACE level.
default void	trace(Object obj)	Logs an object at the TRACE level.
default void	trace(Throwable e)	Logs the stack trace of the given Throwable at the TRACE level.
default void	trace(Throwable e, CharSequence message)	Logs a message at the TRACE level including the stack trace of the given Throwable.
default void	trace(Throwable e, CharSequence message, Object... params)	Logs a message with parameters at the TRACE level including the stack trace of the given Throwable.
default void	warn(CharSequence message)	Logs a message at the WARN level.
default void	warn(CharSequence message, Object... params)	Logs a message with parameters at the WARN level.
default void	warn(Object obj)	Logs an object at the WARN level.
default void	warn(Throwable e)	Logs the stack trace of the given Throwable at the WARN level.
default void	warn(Throwable e, CharSequence message)	Logs a message at the WARN level including the stack trace of the given Throwable.
default void	warn(Throwable e, CharSequence message, Object... params)	Logs a message with parameters at the WARN level including the stack trace of the given Throwable.

Field Detail

NO_EXCEPTION

@Nullable
static final Throwable NO_EXCEPTION

A throwable representing a logging without exception.

WARNING: This field is present to ease the redirection of the methods of this interface; don't use it elsewhere.

NO_MESSAGE

@Nullable
static final CharSequence NO_MESSAGE

A string representing a logging without message.

WARNING: This field is present to ease the redirection of the methods of this interface; don't use it elsewhere.

NO_PARAMS

@Nonnull
static final Object[] NO_PARAMS

An empty array representing logging without parameters.

WARNING: This field is present to ease the redirection of the methods of this interface; don't use it elsewhere.

Method Detail

trace

default void trace(Object obj)

Logs an object at the TRACE level.

Parameters:

obj - the object to log

trace

default void trace(CharSequence message)

Logs a message at the TRACE level.

Parameters:

message - the message to log

trace

default void trace(CharSequence message,
                   Object... params)

Logs a message with parameters at the TRACE level.

Parameters:

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

trace

default void trace(Throwable e)

Logs the stack trace of the given Throwable at the TRACE level.

Parameters:

e - the exception to log, including its stack trace

trace

default void trace(Throwable e,
                   CharSequence message)

Logs a message at the TRACE level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log

trace

default void trace(Throwable e,
                   CharSequence message,
                   Object... params)

Logs a message with parameters at the TRACE level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

debug

default void debug(Object obj)

Logs an object at the DEBUG level.

Parameters:

obj - the object to log

debug

default void debug(CharSequence message)

Logs a message at the DEBUG level.

Parameters:

message - the message to log

debug

default void debug(CharSequence message,
                   Object... params)

Logs a message with parameters at the DEBUG level.

Parameters:

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

debug

default void debug(Throwable e)

Logs the stack trace of the given Throwable at the DEBUG level.

Parameters:

e - the exception to log, including its stack trace

debug

default void debug(Throwable e,
                   CharSequence message)

Logs a message at the DEBUG level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log

debug

default void debug(Throwable e,
                   CharSequence message,
                   Object... params)

Logs a message with parameters at the DEBUG level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

info

default void info(Object obj)

Logs an object at the INFO level.

Parameters:

obj - the object to log

info

default void info(CharSequence message)

Logs a message at the INFO level.

Parameters:

message - the message to log

info

default void info(CharSequence message,
                  Object... params)

Logs a message with parameters at the INFO level.

Parameters:

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

info

default void info(Throwable e)

Logs the stack trace of the given Throwable at the INFO level.

Parameters:

e - the exception to log, including its stack trace

info

default void info(Throwable e,
                  CharSequence message)

Logs a message at the INFO level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log

info

default void info(Throwable e,
                  CharSequence message,
                  Object... params)

Logs a message with parameters at the INFO level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

warn

default void warn(Object obj)

Logs an object at the WARN level.

Parameters:

obj - the object to log

warn

default void warn(CharSequence message)

Logs a message at the WARN level.

Parameters:

message - the message to log

warn

default void warn(CharSequence message,
                  Object... params)

Logs a message with parameters at the WARN level.

Parameters:

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

warn

default void warn(Throwable e)

Logs the stack trace of the given Throwable at the WARN level.

Parameters:

e - the exception to log, including its stack trace

warn

default void warn(Throwable e,
                  CharSequence message)

Logs a message at the WARN level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log

warn

default void warn(Throwable e,
                  CharSequence message,
                  Object... params)

Logs a message with parameters at the WARN level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

error

default void error(Object obj)

Logs an object at the ERROR level.

Parameters:

obj - the object to log

error

default void error(CharSequence message)

Logs a message at the ERROR level.

Parameters:

message - the message to log

error

default void error(CharSequence message,
                   Object... params)

Logs a message with parameters at the ERROR level.

Parameters:

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

error

default void error(Throwable e)

Logs the stack trace of the given Throwable at the ERROR level.

Parameters:

e - the exception to log, including its stack trace

error

default void error(Throwable e,
                   CharSequence message)

Logs a message at the ERROR level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log

error

default void error(Throwable e,
                   CharSequence message,
                   Object... params)

Logs a message with parameters at the ERROR level including the stack trace of the given Throwable.

Parameters:

e - the exception to log, including its stack trace

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

log

default void log(@Nonnull
                 Level level,
                 Object obj)

Logs an object at the given level.

Parameters:

level - the logging level

obj - the object to log

log

default void log(@Nonnull
                 Level level,
                 CharSequence message)

Logs a message at the given level.

Parameters:

level - the logging level

message - the message to log

log

default void log(@Nonnull
                 Level level,
                 CharSequence message,
                 Object... params)

Logs a message with parameters at the given level.

Parameters:

level - the logging level

message - the message to log; the format depends on the MessageFormat

params - parameters to the message

log

default void log(@Nonnull
                 Level level,
                 Throwable e)

Logs the stack trace of the given Throwable at the given level.

Parameters:

level - the logging level

e - the exception to log, including its stack trace

log

default void log(@Nonnull
                 Level level,
                 Throwable e,
                 CharSequence message)

Logs a message at the given level including the stack trace of the given Throwable.

Parameters:

level - the logging level

e - the exception to log, including its stack trace

message - the message to log

log

void log(@Nonnull
         Level level,
         Throwable e,
         CharSequence message,
         Object... params)

Logs a message with parameters at the given level including the stack trace of the given Throwable.

Parameters:

level - the logging level

e - the exception to log, including its stack trace

message - the message to log; the format depends on the MessageFormat

params - parameters to the message