org.logl

Interface LogWriter

public interface LogWriter

A logl LogWriter.

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<LogWriter> fn) Write a set of log messages in a batch.
default void	log(java.lang.CharSequence message) Log a message.
default void	log(java.lang.CharSequence message, java.lang.Throwable cause) Log a message and exception at level.
void	log(LogMessage message) Log a LogMessage.
void	log(LogMessage message, java.lang.Throwable cause) Log a message and exception.
default void	log(java.lang.String pattern, java.lang.Object... args) Log a pattern formatted message.
default void	log(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier) Log the supplied message.
default void	log(java.util.function.Supplier<? extends java.lang.CharSequence> messageSupplier, java.lang.Throwable cause) Log the supplied message and exception.
default void	logf(java.lang.String format, java.lang.Object... args) Log a string formatted message.
static LogWriter	nullWriter()

Method Detail

nullWriter

static LogWriter nullWriter()

Returns:

A LogWriter that returns Logger instances that discards all log messages.

log

void log(LogMessage message)

Log a LogMessage.

Parameters:

message - The message to log.

log

default void log(java.lang.CharSequence message)

Log a message.

Parameters:

message - A character sequence (or String).

log

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

Log the supplied message. The supplier will only be invoked if the log will be written. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

log

void log(LogMessage message,
         java.lang.Throwable cause)

Log a message and exception.

Parameters:

message - The message to log.

cause - The exception to log.

log

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

Log a message and exception at level.

Parameters:

message - A character sequence (or String).

cause - The exception to log.

log

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

Log the supplied message and exception. The supplier will only be invoked if the message will be written to the log. Use this method to avoid expensive string construction when unnecessary.

Parameters:

messageSupplier - A Supplier for the message.

cause - The exception to log.

log

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

Log a pattern formatted message. This defaults to log(LogMessage.patternFormat(pattern, args)), but some logging implementations may provide a more efficient alternative.

Parameters:

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

args - The format arguments.

logf

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

Log a string formatted message. This defaults to log(LogMessage.stringFormat(format, args)), but some logging implementations may provide a more efficient alternative.

Parameters:

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

args - The format arguments.

batch

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

Write a set of log messages in a batch.

The specified Consumer will be invoked with a LogWriter 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 LogWriter.