uk.co.strangeskies.log

Interface Log

All Known Implementing Classes:

LogProvider

public interface Log

A log interface for clients to write events to.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Log.Level The level of importance of a log entry.

Method Summary

Modifier and Type	Method and Description
static Log	discardingLog()
static Log	forwardingLog(Log log) Derive a log which defers to the given if available, or otherwise discards the event.
static Log	forwardingLog(java.util.function.Supplier<Log> logSupplier) Derive a log which defers to the log obtained from the given supplier when available, or otherwise discards the event.
void	log(Log.Level level, java.lang.String message) Log a message.
void	log(Log.Level level, java.lang.String message, java.lang.Throwable exception) Log a message and an associated throwable.
void	log(Log.Level level, java.lang.Throwable exception) Log a message and an associated throwable.
default Log	mapLevel(Log.Level from, Log.Level to) Derive a log which defers to the receiver, after mapping events of level from to events of level to.
default Log	mapMessage(java.util.function.Function<java.lang.String,java.lang.String> mapping) Derive a log which defers to the receiver, after modifying the string message according to the given function.
default Log	mapThrowable(java.util.function.Function<java.lang.Throwable,java.lang.Throwable> mapping) Derive a log which defers to the receiver, after modifying the throwable according to the given function where relevant.
static Log	simpleLog(java.util.function.BiConsumer<Log.Level,java.lang.String> action) Create a simple log which derives messages according to exceptions and otherwise discards exception information.
static Log	simpleLog(java.util.function.Consumer<java.lang.String> action) Create a simple log which derives messages according to levels and exceptions and otherwise discards level and exception information.

Method Detail

log

void log(Log.Level level,
         java.lang.String message)

Log a message.

Parameters:

level - The importance level of the given message

message - The message to log

log

void log(Log.Level level,
         java.lang.String message,
         java.lang.Throwable exception)

Log a message and an associated throwable.

Parameters:

level - The importance level of the given message

message - The message to log

exception - The exception associated with the message

log

void log(Log.Level level,
         java.lang.Throwable exception)

Log a message and an associated throwable.

Parameters:

level - The importance level of the given message

exception - The exception associated with the message

simpleLog

static Log simpleLog(java.util.function.BiConsumer<Log.Level,java.lang.String> action)

Create a simple log which derives messages according to exceptions and otherwise discards exception information.

Parameters:

action - the action upon receiving the level and derived message string for a log event

Returns:

a log implementing the given behavior

simpleLog

static Log simpleLog(java.util.function.Consumer<java.lang.String> action)

Create a simple log which derives messages according to levels and exceptions and otherwise discards level and exception information.

Parameters:

action - the action upon receiving the derived message string for a log event

Returns:

a log implementing the given behavior

forwardingLog

static Log forwardingLog(Log log)

Derive a log which defers to the given if available, or otherwise discards the event.

Parameters:

log - a nullable reference to a log instance

Returns:

the derived log

forwardingLog

static Log forwardingLog(java.util.function.Supplier<Log> logSupplier)

Derive a log which defers to the log obtained from the given supplier when available, or otherwise discards the event.

Parameters:

logSupplier - an supplier which may be able to find a log to defer to

Returns:

the derived log

discardingLog

static Log discardingLog()

Returns:

a log which discards all events

mapMessage

default Log mapMessage(java.util.function.Function<java.lang.String,java.lang.String> mapping)

Derive a log which defers to the receiver, after modifying the string message according to the given function.

Parameters:

mapping - the mapping function to modify the message strings

Returns:

the derived log

mapLevel

default Log mapLevel(Log.Level from,
                     Log.Level to)

Derive a log which defers to the receiver, after mapping events of level from to events of level to.

Parameters:

from - the level to map from

to - the level to map to

Returns:

the derived log

mapThrowable

default Log mapThrowable(java.util.function.Function<java.lang.Throwable,java.lang.Throwable> mapping)

Derive a log which defers to the receiver, after modifying the throwable according to the given function where relevant.

Parameters:

mapping - the mapping function to modify the logged exceptions

Returns:

the derived log