ome.smuggler.core.service.log

Class BaseLogger

java.lang.Object

ome.smuggler.core.service.log.BaseLogger

All Implemented Interfaces:

LogService

Direct Known Subclasses:

ImportLogger, MailLogger, OmeroLogger

public class BaseLogger
extends java.lang.Object
implements LogService

Base class for loggers that extend the basic functionality of the LogService to provide logging tailored to a particular service.

Constructor Summary

Constructors

Constructor and Description
BaseLogger(LogService service) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.Object site, java.util.function.Consumer<java.io.PrintWriter> messageWriter) Logs a debug message.
void	error(java.lang.Object site, java.util.function.Consumer<java.io.PrintWriter> messageWriter) Logs an error.
static java.lang.String	fieldsToString(java.util.stream.Stream<util.object.Pair<java.lang.Object,java.lang.Object>> fields) Prints the given name-value pairs, one per line, into a string.
static java.util.function.Consumer<java.io.PrintWriter>	fieldsWriter(java.lang.String header, java.util.stream.Stream<util.object.Pair<java.lang.Object,java.lang.Object>>... fields) Builds a consumer that writes the given name-value pairs to a PrintWriter buffer using the fieldsToString method.
void	info(java.lang.Object site, java.util.function.Consumer<java.io.PrintWriter> messageWriter) Logs an informational message.
void	transientError(java.lang.Object site, java.util.Optional<java.lang.Throwable>... maybeE) Logs a warning containing a summary of the error and a debug message with the entire exception's stack trace for each non-empty optional in the list.
void	transientError(java.lang.Object site, java.lang.Throwable error) Logs a warning containing a summary of the error and a debug message with the entire exception's stack trace.
void	warn(java.lang.Object site, java.util.function.Consumer<java.io.PrintWriter> messageWriter) Logs a warning.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseLogger

public BaseLogger(LogService service)

Creates a new instance.

Parameters:

service - the underlying log service.

Throws:

java.lang.NullPointerException - if the argument is null.

Method Detail

fieldsToString

public static java.lang.String fieldsToString(java.util.stream.Stream<util.object.Pair<java.lang.Object,java.lang.Object>> fields)

Prints the given name-value pairs, one per line, into a string. Each line has the format: ">>> name: value".

Parameters:

fields - the pairs to print.

Returns:

a string containing the printed pairs.

Throws:

java.lang.NullPointerException - if the argument is null.

fieldsWriter

@SafeVarargs
public static java.util.function.Consumer<java.io.PrintWriter> fieldsWriter(java.lang.String header,
                                                                                         java.util.stream.Stream<util.object.Pair<java.lang.Object,java.lang.Object>>... fields)

Builds a consumer that writes the given name-value pairs to a PrintWriter buffer using the fieldsToString method.

Parameters:

header - the first line to output.

fields - the name-value pairs to output.

Returns:

the consumer.

Throws:

java.lang.NullPointerException - if any argument is null.

debug

public void debug(java.lang.Object site,
                  java.util.function.Consumer<java.io.PrintWriter> messageWriter)

Description copied from interface: LogService

Logs a debug message.

Specified by:

debug in interface LogService

Parameters:

site - where the event occurred or the object the event is associated to.

messageWriter - writes the content of the log message.

info

public void info(java.lang.Object site,
                 java.util.function.Consumer<java.io.PrintWriter> messageWriter)

Description copied from interface: LogService

Logs an informational message.

Specified by:

info in interface LogService

Parameters:

site - where the event occurred or the object the event is associated to.

messageWriter - writes the content of the log message.

warn

public void warn(java.lang.Object site,
                 java.util.function.Consumer<java.io.PrintWriter> messageWriter)

Description copied from interface: LogService

Logs a warning.

Specified by:

warn in interface LogService

Parameters:

site - where the event occurred or the object the event is associated to.

messageWriter - writes the content of the log message.

error

public void error(java.lang.Object site,
                  java.util.function.Consumer<java.io.PrintWriter> messageWriter)

Description copied from interface: LogService

Logs an error.

Specified by:

error in interface LogService

Parameters:

site - where the event occurred or the object the event is associated to.

messageWriter - writes the content of the log message.

transientError

public void transientError(java.lang.Object site,
                           java.lang.Throwable error)

Logs a warning containing a summary of the error and a debug message with the entire exception's stack trace.

Parameters:

site - where the error was detected.

error - the error that was caught.

Throws:

java.lang.NullPointerException - if any argument is null.

transientError

@SafeVarargs
public final void transientError(java.lang.Object site,
                                              java.util.Optional<java.lang.Throwable>... maybeE)

Logs a warning containing a summary of the error and a debug message with the entire exception's stack trace for each non-empty optional in the list.

Parameters:

site - where the error was detected.

maybeE - errors that were caught, possibly none. If the array is null, nothing is logged. Any null or empty element will be skipped.

Throws:

java.lang.NullPointerException - if the site argument is null.