net.maritimecloud.msdl

Class MsdlLogger

java.lang.Object

net.maritimecloud.msdl.MsdlLogger

public abstract class MsdlLogger
extends Object

The main logging interface for plugins.

Author:

Kasper Nielsen

Constructor Summary

Constructors

Constructor and Description
MsdlLogger()

Method Summary

Modifier and Type	Method and Description
abstract void	debug(CharSequence message) Send a message to the user at debug error level.
abstract void	debug(CharSequence message, Throwable error) Send a message and exception to the user at the debug error level.
abstract void	error(CharSequence message) Send a message to the user at the error error level.
abstract void	error(CharSequence message, Throwable error) Send a message and exception to the user at the error error level.
static MsdlLogger	errorCountingLogger(MsdlLogger logger, AtomicInteger errorCounter) Returns a logger that will delegate all invocations to the specified logger.
abstract void	info(CharSequence message) Send a message to the user at the info error level.
abstract void	info(CharSequence message, Throwable error) Send a message and exception to the user at the info error level.
abstract void	warn(CharSequence message) Send a message to the user at the warn error level.
abstract void	warn(CharSequence message, Throwable error) Send a message and exception to the user at the warn error level.
static MsdlLogger	wrapJUL(Logger logger) Wraps a java util logger in a MSDL logger.

Methods inherited from class java.lang.Object

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

Constructor Detail

MsdlLogger

public MsdlLogger()

Method Detail

debug

public abstract void debug(CharSequence message)

Send a message to the user at debug error level.

Parameters:

message - the message to send

debug

public abstract void debug(CharSequence message,
                           Throwable error)

Send a message and exception to the user at the debug error level.

Parameters:

message - the message to send

error - the exception

error

public abstract void error(CharSequence message)

Send a message to the user at the error error level.

Parameters:

message - the message to send

error

public abstract void error(CharSequence message,
                           Throwable error)

Send a message and exception to the user at the error error level.

Parameters:

message - the message to send

error - the exception

info

public abstract void info(CharSequence message)

Send a message to the user at the info error level.

Parameters:

message - the message to send

info

public abstract void info(CharSequence message,
                          Throwable error)

Send a message and exception to the user at the info error level.

Parameters:

message - the message to send

error - the exception

warn

public abstract void warn(CharSequence message)

Send a message to the user at the warn error level.

Parameters:

message - the message to send

warn

public abstract void warn(CharSequence message,
                          Throwable error)

Send a message and exception to the user at the warn error level.

Parameters:

message - the message to send

error - the exception

errorCountingLogger

public static MsdlLogger errorCountingLogger(MsdlLogger logger,
                                             AtomicInteger errorCounter)

Returns a logger that will delegate all invocations to the specified logger. Furthermore, each time a message is logged at error level the specified error counter will be incremented via AtomicInteger.incrementAndGet()

Parameters:

logger - the logger to wrap

errorCounter - the counter to increment each time a message is logged at the error level.

Returns:

the wrapped logger

wrapJUL

public static MsdlLogger wrapJUL(Logger logger)

Wraps a java util logger in a MSDL logger.

Parameters:

logger - the logger to wrap

Returns:

the wrapped logger