org.logl

Interface Logger

All Known Subinterfaces:

AdjustableLogger

All Known Implementing Classes:

DuplicatingLogger, JULLogger, Log4j2Logger, Slf4jLogger

public interface Logger

A logl Logger.

This interface provides all the common logging methods used at runtime.

Method Summary

Modifier and Type	Method and Description
void	batch(java.util.function.Consumer<Logger> fn) Write a set of log messages in a batch.
default void	debug(java.lang.CharSequence message) Log a message at level DEBUG, if enabled.
default void	debug(java.lang.CharSequence message, java.lang.Throwable cause) Log a message and exception at level DEBUG, if enabled.
default void	debug(LogMessage message) Log a LogMessage at level DEBUG, if enabled.
default void	debug(LogMessage message, java.lang.Throwable cause) Log a message and exception at level DEBUG, if enabled.
default void	debug(java.lang.String pattern, java.lang.Object... args) Log a pattern formatted message at level DEBUG, if enabled.
default void	debug(java.lang.String pattern, java.lang.Object arg) Log a pattern formatted message at level DEBUG, if enabled.
default void	debug(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level DEBUG, if enabled.
default void	debug(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level DEBUG, if enabled.
default void	debug(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level DEBUG, if enabled.
default void	debug(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level DEBUG, if enabled.
default void	debug(java.lang.String message, java.lang.Throwable cause) Log a message and exception at level DEBUG, if enabled.
default void	debug(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier) Log the supplied message at level DEBUG, if enabled.
default void	debug(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier, java.lang.Throwable cause) Log the supplied message and exception at level DEBUG, if enabled.
default void	debugf(java.lang.String format, java.lang.Object... args) Log a string formatted message at level DEBUG, if enabled.
default void	debugf(java.lang.String format, java.lang.Object arg) Log a pattern formatted message at level DEBUG, if enabled.
default void	debugf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level DEBUG, if enabled.
default void	debugf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level DEBUG, if enabled.
default void	debugf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level DEBUG, if enabled.
default void	debugf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level DEBUG, if enabled.
LogWriter	debugWriter()
default void	error(java.lang.CharSequence message) Log a message at level ERROR, if enabled.
default void	error(java.lang.CharSequence message, java.lang.Throwable cause) Log a message and exception at level ERROR, if enabled.
default void	error(LogMessage message) Log a LogMessage at level ERROR, if enabled.
default void	error(LogMessage message, java.lang.Throwable cause) Log a message and exception at level ERROR, if enabled.
default void	error(java.lang.String pattern, java.lang.Object... args) Log a pattern formatted message at level ERROR, if enabled.
default void	error(java.lang.String pattern, java.lang.Object arg) Log a pattern formatted message at level ERROR, if enabled.
default void	error(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level ERROR, if enabled.
default void	error(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level ERROR, if enabled.
default void	error(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level ERROR, if enabled.
default void	error(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level ERROR, if enabled.
default void	error(java.lang.String message, java.lang.Throwable cause) Log a message and exception at level ERROR, if enabled.
default void	error(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier) Log the supplied message at level ERROR, if enabled.
default void	error(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier, java.lang.Throwable cause) Log the supplied message and exception at level ERROR, if enabled.
default void	errorf(java.lang.String format, java.lang.Object... args) Log a string formatted message at level ERROR, if enabled.
default void	errorf(java.lang.String format, java.lang.Object arg) Log a pattern formatted message at level ERROR, if enabled.
default void	errorf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level ERROR, if enabled.
default void	errorf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level ERROR, if enabled.
default void	errorf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level ERROR, if enabled.
default void	errorf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level ERROR, if enabled.
LogWriter	errorWriter()
Level	getLevel()
default void	info(java.lang.CharSequence message) Log a message at level INFO, if enabled.
default void	info(java.lang.CharSequence message, java.lang.Throwable cause) Log a message and exception at level INFO, if enabled.
default void	info(LogMessage message) Log a LogMessage at level INFO, if enabled.
default void	info(LogMessage message, java.lang.Throwable cause) Log a message and exception at level INFO, if enabled.
default void	info(java.lang.String pattern, java.lang.Object... args) Log a pattern formatted message at level INFO, if enabled.
default void	info(java.lang.String pattern, java.lang.Object arg) Log a pattern formatted message at level INFO, if enabled.
default void	info(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level INFO, if enabled.
default void	info(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level INFO, if enabled.
default void	info(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level INFO, if enabled.
default void	info(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level INFO, if enabled.
default void	info(java.lang.String message, java.lang.Throwable cause) Log a message and exception at level INFO, if enabled.
default void	info(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier) Log the supplied message at level INFO, if enabled.
default void	info(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier, java.lang.Throwable cause) Log the supplied message and exception at level INFO, if enabled.
default void	infof(java.lang.String format, java.lang.Object... args) Log a string formatted message at level INFO, if enabled.
default void	infof(java.lang.String format, java.lang.Object arg) Log a pattern formatted message at level INFO, if enabled.
default void	infof(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level INFO, if enabled.
default void	infof(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level INFO, if enabled.
default void	infof(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level INFO, if enabled.
default void	infof(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level INFO, if enabled.
LogWriter	infoWriter()
default boolean	isDebugEnabled()
default boolean	isEnabled(Level level) Check if a logging level is enabled.
default boolean	isErrorEnabled()
default boolean	isInfoEnabled()
default boolean	isWarnEnabled()
static Logger	nullLogger()
default void	warn(java.lang.CharSequence message) Log a message at level WARN, if enabled.
default void	warn(java.lang.CharSequence message, java.lang.Throwable cause) Log a message and exception at level WARN, if enabled.
default void	warn(LogMessage message) Log a LogMessage at level WARN, if enabled.
default void	warn(LogMessage message, java.lang.Throwable cause) Log a message and exception at level WARN, if enabled.
default void	warn(java.lang.String pattern, java.lang.Object... args) Log a pattern formatted message at level WARN, if enabled.
default void	warn(java.lang.String pattern, java.lang.Object arg) Log a pattern formatted message at level WARN, if enabled.
default void	warn(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level WARN, if enabled.
default void	warn(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level WARN, if enabled.
default void	warn(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level WARN, if enabled.
default void	warn(java.lang.String pattern, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level WARN, if enabled.
default void	warn(java.lang.String message, java.lang.Throwable cause) Log a message and exception at level WARN, if enabled.
default void	warn(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier) Log the supplied message at level WARN, if enabled.
default void	warn(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier, java.lang.Throwable cause) Log the supplied message and exception at level WARN, if enabled.
default void	warnf(java.lang.String format, java.lang.Object... args) Log a string formatted message at level WARN, if enabled.
default void	warnf(java.lang.String format, java.lang.Object arg) Log a pattern formatted message at level WARN, if enabled.
default void	warnf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2) Log a pattern formatted message at level WARN, if enabled.
default void	warnf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Log a pattern formatted message at level WARN, if enabled.
default void	warnf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Log a pattern formatted message at level WARN, if enabled.
default void	warnf(java.lang.String format, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5) Log a pattern formatted message at level WARN, if enabled.
LogWriter	warnWriter()
default LogWriter	writer(Level level) Get a LogWriter for the specified level.

Method Detail

nullLogger

static Logger nullLogger()

Returns:

A Logger that discards all log messages.

getLevel

Level getLevel()

Returns:

The Level that logging is set to.

isEnabled

default boolean isEnabled(Level level)

Check if a logging level is enabled.

Parameters:

level - The Level to check.

Returns:

true if logging is enabled for that level.

writer

default LogWriter writer(Level level)

Get a LogWriter for the specified level.

Parameters:

level - The Level the writer should log to.

Returns:

A LogWriter that writes logs at the specified level.

isErrorEnabled

default boolean isErrorEnabled()

Returns:

true if the log level Level.ERROR is enabled.

error

default void error(LogMessage message)

Log a LogMessage at level ERROR, if enabled.

Parameters:

message - The message to log.

error

default void error(java.lang.CharSequence message)

Log a message at level ERROR, if enabled.

Parameters:

message - A character sequence (or String).

error

default void error(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier)

Log the supplied message at level ERROR, if enabled. The supplier will only be invoked if the level ERROR is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

error

default void error(LogMessage message,
                   java.lang.Throwable cause)

Log a message and exception at level ERROR, if enabled.

Parameters:

message - The message to log.

cause - The exception to log.

error

default void error(java.lang.CharSequence message,
                   java.lang.Throwable cause)

Log a message and exception at level ERROR, if enabled.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

error

default void error(java.lang.String message,
                   java.lang.Throwable cause)

Log a message and exception at level ERROR, if enabled.

Parameters:

message - A string.

cause - The exception to log.

error

default void error(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier,
                   java.lang.Throwable cause)

Log the supplied message and exception at level ERROR, if enabled. The supplier will only be invoked if the level ERROR is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

cause - The exception to log.

error

default void error(java.lang.String pattern,
                   java.lang.Object... args)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, args)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

args - The format arguments.

error

default void error(java.lang.String pattern,
                   java.lang.Object arg)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg - A format argument.

error

default void error(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

error

default void error(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

error

default void error(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

error

default void error(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4,
                   java.lang.Object arg5)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

errorf

default void errorf(java.lang.String format,
                    java.lang.Object... args)

Log a string formatted message at level ERROR, if enabled. This is equivalent to info(LogMessage.stringFormat(format, args)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

args - The format arguments.

errorf

default void errorf(java.lang.String format,
                    java.lang.Object arg)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg - A format argument.

errorf

default void errorf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

errorf

default void errorf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2,
                    java.lang.Object arg3)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

errorf

default void errorf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2,
                    java.lang.Object arg3,
                    java.lang.Object arg4)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

errorf

default void errorf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2,
                    java.lang.Object arg3,
                    java.lang.Object arg4,
                    java.lang.Object arg5)

Log a pattern formatted message at level ERROR, if enabled. This is equivalent to error(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

errorWriter

LogWriter errorWriter()

Returns:

A LogWriter that writes logs at level ERROR.

isWarnEnabled

default boolean isWarnEnabled()

Returns:

true if the log level Level.WARN is enabled.

warn

default void warn(LogMessage message)

Log a LogMessage at level WARN, if enabled.

Parameters:

message - The message to log.

warn

default void warn(java.lang.CharSequence message)

Log a message at level WARN, if enabled.

Parameters:

message - A character sequence (or String).

warn

default void warn(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier)

Log the supplied message at level WARN, if enabled. The supplier will only be invoked if the level WARN is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

warn

default void warn(LogMessage message,
                  java.lang.Throwable cause)

Log a message and exception at level WARN, if enabled.

Parameters:

message - The message to log.

cause - The exception to log.

warn

default void warn(java.lang.CharSequence message,
                  java.lang.Throwable cause)

Log a message and exception at level WARN, if enabled.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

warn

default void warn(java.lang.String message,
                  java.lang.Throwable cause)

Log a message and exception at level WARN, if enabled.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

warn

default void warn(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier,
                  java.lang.Throwable cause)

Log the supplied message and exception at level WARN, if enabled. The supplier will only be invoked if the level WARN is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

cause - The exception to log.

warn

default void warn(java.lang.String pattern,
                  java.lang.Object... args)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, args)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

args - The format arguments.

warn

default void warn(java.lang.String pattern,
                  java.lang.Object arg)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg - A format argument.

warn

default void warn(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

warn

default void warn(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2,
                  java.lang.Object arg3)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

warn

default void warn(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2,
                  java.lang.Object arg3,
                  java.lang.Object arg4)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

warn

default void warn(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2,
                  java.lang.Object arg3,
                  java.lang.Object arg4,
                  java.lang.Object arg5)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

warnf

default void warnf(java.lang.String format,
                   java.lang.Object... args)

Log a string formatted message at level WARN, if enabled. This is equivalent to info(LogMessage.stringFormat(format, args)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

args - The format arguments.

warnf

default void warnf(java.lang.String format,
                   java.lang.Object arg)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg - A format argument.

warnf

default void warnf(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

warnf

default void warnf(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

warnf

default void warnf(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

warnf

default void warnf(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4,
                   java.lang.Object arg5)

Log a pattern formatted message at level WARN, if enabled. This is equivalent to warn(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

warnWriter

LogWriter warnWriter()

Returns:

A LogWriter that writes logs at level WARN.

isInfoEnabled

default boolean isInfoEnabled()

Returns:

true if the log level Level.INFO is enabled.

info

default void info(LogMessage message)

Log a LogMessage at level INFO, if enabled.

Parameters:

message - The message to log.

info

default void info(java.lang.CharSequence message)

Log a message at level INFO, if enabled.

Parameters:

message - A character sequence (or String).

info

default void info(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier)

Log the supplied message at level INFO, if enabled. The supplier will only be invoked if the level INFO is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

info

default void info(java.lang.CharSequence message,
                  java.lang.Throwable cause)

Log a message and exception at level INFO, if enabled.

Parameters:

message - The message to log.

cause - The exception to log.

info

default void info(java.lang.String message,
                  java.lang.Throwable cause)

Log a message and exception at level INFO, if enabled.

Parameters:

message - The message to log.

cause - The exception to log.

info

default void info(LogMessage message,
                  java.lang.Throwable cause)

Log a message and exception at level INFO, if enabled.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

info

default void info(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier,
                  java.lang.Throwable cause)

Log the supplied message and exception at level INFO, if enabled. The supplier will only be invoked if the level INFO is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

cause - The exception to log.

info

default void info(java.lang.String pattern,
                  java.lang.Object... args)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, args)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format pattern, as per LogMessage.patternFormat(String, Object...).

args - The format arguments.

info

default void info(java.lang.String pattern,
                  java.lang.Object arg)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg - A format argument.

info

default void info(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

info

default void info(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2,
                  java.lang.Object arg3)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

info

default void info(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2,
                  java.lang.Object arg3,
                  java.lang.Object arg4)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

info

default void info(java.lang.String pattern,
                  java.lang.Object arg1,
                  java.lang.Object arg2,
                  java.lang.Object arg3,
                  java.lang.Object arg4,
                  java.lang.Object arg5)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

infof

default void infof(java.lang.String format,
                   java.lang.Object... args)

Log a string formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.stringFormat(format, args)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

args - The format arguments.

infof

default void infof(java.lang.String format,
                   java.lang.Object arg)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg - A format argument.

infof

default void infof(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

infof

default void infof(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

infof

default void infof(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

infof

default void infof(java.lang.String format,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4,
                   java.lang.Object arg5)

Log a pattern formatted message at level INFO, if enabled. This is equivalent to info(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

infoWriter

LogWriter infoWriter()

Returns:

A LogWriter that writes logs at level INFO.

isDebugEnabled

default boolean isDebugEnabled()

Returns:

true if the log level Level.DEBUG is enabled.

debug

default void debug(LogMessage message)

Log a LogMessage at level DEBUG, if enabled.

Parameters:

message - The message to log.

debug

default void debug(java.lang.CharSequence message)

Log a message at level DEBUG, if enabled.

Parameters:

message - A character sequence (or String).

debug

default void debug(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier)

Log the supplied message at level DEBUG, if enabled. The supplier will only be invoked if the level DEBUG is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

debug

default void debug(LogMessage message,
                   java.lang.Throwable cause)

Log a message and exception at level DEBUG, if enabled.

Parameters:

message - The message to log.

cause - The exception to log.

debug

default void debug(java.lang.CharSequence message,
                   java.lang.Throwable cause)

Log a message and exception at level DEBUG, if enabled.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

debug

default void debug(java.lang.String message,
                   java.lang.Throwable cause)

Log a message and exception at level DEBUG, if enabled.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

debug

default void debug(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier,
                   java.lang.Throwable cause)

Log the supplied message and exception at level DEBUG, if enabled. The supplier will only be invoked if the level DEBUG is enabled. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

cause - The exception to log.

debug

default void debug(java.lang.String pattern,
                   java.lang.Object... args)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, args)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

args - The format arguments.

debug

default void debug(java.lang.String pattern,
                   java.lang.Object arg)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg - A format argument.

debug

default void debug(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

debug

default void debug(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

debug

default void debug(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

debug

default void debug(java.lang.String pattern,
                   java.lang.Object arg1,
                   java.lang.Object arg2,
                   java.lang.Object arg3,
                   java.lang.Object arg4,
                   java.lang.Object arg5)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

pattern - The format string, as per LogMessage.patternFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

debugf

default void debugf(java.lang.String format,
                    java.lang.Object... args)

Log a string formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.stringFormat(format, args)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format string, as per LogMessage.stringFormat(String, Object...).

args - The format arguments.

debugf

default void debugf(java.lang.String format,
                    java.lang.Object arg)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg - A format argument.

debugf

default void debugf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

debugf

default void debugf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2,
                    java.lang.Object arg3)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2, arg3)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

debugf

default void debugf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2,
                    java.lang.Object arg3,
                    java.lang.Object arg4)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

debugf

default void debugf(java.lang.String format,
                    java.lang.Object arg1,
                    java.lang.Object arg2,
                    java.lang.Object arg3,
                    java.lang.Object arg4,
                    java.lang.Object arg5)

Log a pattern formatted message at level DEBUG, if enabled. This is equivalent to debug(LogMessage.patternFormat(pattern, arg1, arg2, arg3, arg4, arg5)), but may be slightly more efficient in some logging implementations.

Parameters:

format - The format pattern, as per LogMessage.stringFormat(String, Object...).

arg1 - A format argument.

arg2 - A format argument.

arg3 - A format argument.

arg4 - A format argument.

arg5 - A format argument.

debugWriter

LogWriter debugWriter()

Returns:

A LogWriter that writes logs at level DEBUG.

batch

void batch(java.util.function.Consumer<Logger> fn)

Write a set of log messages in a batch.

The specified Consumer will be invoked with a Logger that collects all log output and then writes them all consecutively when the consumer invocation returns. Use this when a set of log lines must appear consecutively in the log, regardless of time ordering.

Note: most implementations do not guarantee log ordering, so log lines may not always be ordered correctly by timestamp. This is especially true when logs are written in batch.

Parameters:

fn - A Consumer that will be invoked with the batching Logger.