Package com.guinetik.corefun

Interface Loggable.Logger

Enclosing interface:

Loggable

public static interface Loggable.Logger

A simple, framework-agnostic logger interface.

Logger provides a minimal set of logging methods that can be implemented by delegating to any logging framework. Factory methods are provided for common use cases.

Since:

0.1.0

Author:

Guinetik <guinetik@gmail.com>

Method Summary

Modifier and Type	Method	Description
default void	debug(String message)	Logs a debug message.
void	error(String message)	Logs an error message.
void	error(String message, Throwable throwable)	Logs an error message with an exception.
void	info(String message)	Logs an informational message.
static Loggable.Logger	noop()	Creates a no-op Logger that discards all messages.
static Loggable.Logger	of(Consumer<String> info, Consumer<String> warn, Consumer<String> error)	Creates a Logger from individual log functions.
static Loggable.Logger	of(Consumer<String> info, Consumer<String> warn, Consumer<String> error, BiConsumer<String,Throwable> errorWithThrowable)	Creates a Logger with error-with-throwable support.
static Loggable.Logger	println()	Creates a Logger that prints to stdout/stderr.
static Loggable.Logger	tagged(String tag, Loggable.Logger delegate)	Creates a Logger that prefixes all messages with a tag.
default void	trace(String message)	Logs a trace message.
void	warn(String message)	Logs a warning message.

Method Details

info

void info(String message)

Logs an informational message.

Parameters:

message - the message to log

warn

void warn(String message)

Logs a warning message.

Parameters:

message - the message to log

error

void error(String message)

Logs an error message.

Parameters:

message - the message to log

error

void error(String message,
 Throwable throwable)

Logs an error message with an exception.

Parameters:

message - the message to log

throwable - the exception to log

debug

default void debug(String message)

Logs a debug message.

Parameters:

message - the message to log

trace

default void trace(String message)

Logs a trace message.

Parameters:

message - the message to log

of

static Loggable.Logger of(Consumer<String> info,
 Consumer<String> warn,
 Consumer<String> error)

Creates a Logger from individual log functions.

Parameters:

info - function for info messages

warn - function for warn messages

error - function for error messages

Returns:

a configured Logger

of

static Loggable.Logger of(Consumer<String> info,
 Consumer<String> warn,
 Consumer<String> error,
 BiConsumer<String,Throwable> errorWithThrowable)

Creates a Logger with error-with-throwable support.

Parameters:

info - function for info messages

warn - function for warn messages

error - function for error messages

errorWithThrowable - function for error messages with throwables

Returns:

a configured Logger

println

static Loggable.Logger println()

Creates a Logger that prints to stdout/stderr.

Returns:

a println-based Logger

noop

static Loggable.Logger noop()

Creates a no-op Logger that discards all messages.

Returns:

a silent Logger

tagged

static Loggable.Logger tagged(String tag,
 Loggable.Logger delegate)

Creates a Logger that prefixes all messages with a tag.

Parameters:

tag - the prefix tag (typically class name)

delegate - the Logger to delegate to

Returns:

a tagged Logger