org.msbotframework4j.logging

Class AbstractBotLogger

java.lang.Object

org.msbotframework4j.logging.AbstractBotLogger

All Implemented Interfaces:

BotLogger

Direct Known Subclasses:

SimpleBotLogger, Slf4jBotLogger

public abstract class AbstractBotLogger
extends Object
implements BotLogger

Base class for adapters for bot logging system

Author:

Maksim Kanev

Constructor Summary

Constructors

Constructor and Description
AbstractBotLogger()

Method Summary

Methods

Modifier and Type	Method and Description
BotLogEntryBuilder	composeLogMessage() Creates a builder which simplifies the message configuration
void	debug(String message) Logs a message at the DEBUG level
void	debug(String message, Throwable exception) Logs an exception (throwable) at the DEBUG level with an accompanying message.
void	error(String message) Logs a message at the ERROR level
void	error(String message, Throwable exception) Logs an exception (throwable) at the ERROR level with an accompanying message.
protected String	formatLogEntry(BotLogEntry entry) Base method to convert log entry to String.
protected DateFormat	getDateFormat() Return default date format
void	info(String message) Logs a message at the INFO level
void	info(String message, Throwable exception) Logs an exception (throwable) at the INFO level with an accompanying message.
void	log(BotLogEntry entry) Writes log entry to logging stream
void	log(BotLogSeverity severity, String message, Throwable exception) Logs an exception with exact severity level with an accompanying message
void	warn(String message) Logs a message at the WARNING level
void	warn(String message, Throwable exception) Logs an exception (throwable) at the WARNING level with an accompanying message.
protected abstract void	writeToSink(BotLogEntry entry) Customizable method which writes log entry to exact resource

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBotLogger

public AbstractBotLogger()

Method Detail

debug

public void debug(String message)

Description copied from interface: BotLogger

Logs a message at the DEBUG level

Specified by:

debug in interface BotLogger

Parameters:

message - the message String to be logged

debug

public void debug(String message,
         Throwable exception)

Description copied from interface: BotLogger

Logs an exception (throwable) at the DEBUG level with an accompanying message.

Specified by:

debug in interface BotLogger

Parameters:

message - the message accompanying the exception

exception - the exception (throwable) to log

info

public void info(String message)

Description copied from interface: BotLogger

Logs a message at the INFO level

Specified by:

info in interface BotLogger

Parameters:

message - the message String to be logged

info

public void info(String message,
        Throwable exception)

Description copied from interface: BotLogger

Logs an exception (throwable) at the INFO level with an accompanying message.

Specified by:

info in interface BotLogger

Parameters:

message - the message accompanying the exception

exception - the exception (throwable) to log

warn

public void warn(String message)

Description copied from interface: BotLogger

Logs a message at the WARNING level

Specified by:

warn in interface BotLogger

Parameters:

message - the message String to be logged

warn

public void warn(String message,
        Throwable exception)

Description copied from interface: BotLogger

Logs an exception (throwable) at the WARNING level with an accompanying message.

Specified by:

warn in interface BotLogger

Parameters:

message - the message accompanying the exception

exception - the exception (throwable) to log

error

public void error(String message)

Description copied from interface: BotLogger

Logs a message at the ERROR level

Specified by:

error in interface BotLogger

Parameters:

message - the message String to be logged

error

public void error(String message,
         Throwable exception)

Description copied from interface: BotLogger

Logs an exception (throwable) at the ERROR level with an accompanying message.

Specified by:

error in interface BotLogger

Parameters:

message - the message accompanying the exception

exception - the exception (throwable) to log

log

public void log(BotLogSeverity severity,
       String message,
       Throwable exception)

Description copied from interface: BotLogger

Logs an exception with exact severity level with an accompanying message

Specified by:

log in interface BotLogger

Parameters:

severity - severity level

message - the message accompanying the exception

exception - the exception (throwable) to log

log

public void log(BotLogEntry entry)

Description copied from interface: BotLogger

Writes log entry to logging stream

Specified by:

log in interface BotLogger

Parameters:

entry - log entry

formatLogEntry

protected String formatLogEntry(BotLogEntry entry)

Base method to convert log entry to String. Default format would be like Wed, 4 Jul 2001 12:08:56 -0700 INFO This is a test message

Parameters:

entry - log entry

Returns:

string representation of log entry

getDateFormat

protected DateFormat getDateFormat()

Return default date format

Returns:

default date format

writeToSink

protected abstract void writeToSink(BotLogEntry entry)

Customizable method which writes log entry to exact resource

Parameters:

entry - log entry

composeLogMessage

public BotLogEntryBuilder composeLogMessage()

Creates a builder which simplifies the message configuration

Specified by:

composeLogMessage in interface BotLogger

Returns:

BotLogEntryBuilder instance