com.github.dm.jrt.log

Class TemplateLog

java.lang.Object

com.github.dm.jrt.log.TemplateLog

All Implemented Interfaces:

Log

Direct Known Subclasses:

NullLog, SystemLog

public abstract class TemplateLog
extends Object
implements Log

Abstract implementation of a log.

This class is useful to avoid the need of implementing all the methods defined in the interface.

A standard format is applied to the log messages.
The inheriting class may just implement the writing of the formatted message, or customize it at any level.

Created by davide-maestroni on 10/03/2014.

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.dm.jrt.log.Log

Log.Level

Constructor Summary

Constructors

Constructor and Description
TemplateLog()

Method Summary

Methods

Modifier and Type	Method and Description
void	dbg(List<Object> contexts, String message, Throwable throwable) Logs a debug message.
void	err(List<Object> contexts, String message, Throwable throwable) Logs an error message.
static String	printStackTrace(Throwable throwable) Prints the stack trace of the specified throwable into a string.
void	wrn(List<Object> contexts, String message, Throwable throwable) Logs a warning message.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateLog

public TemplateLog()

Method Detail

printStackTrace

@NotNull
public static String printStackTrace(@NotNull
                             Throwable throwable)

Prints the stack trace of the specified throwable into a string.

Parameters:

throwable - the throwable instance.

Returns:

the printed stack trace.

dbg

public void dbg(@NotNull
       List<Object> contexts,
       @Nullable
       String message,
       @Nullable
       Throwable throwable)

Description copied from interface: Log

Logs a debug message.

Specified by:

dbg in interface Log

Parameters:

contexts - the list of contexts.

message - the message.

throwable - the optional throwable or null.

err

public void err(@NotNull
       List<Object> contexts,
       @Nullable
       String message,
       @Nullable
       Throwable throwable)

Description copied from interface: Log

Logs an error message.

Specified by:

err in interface Log

Parameters:

contexts - the list of contexts.

message - the message.

throwable - the optional throwable or null.

wrn

public void wrn(@NotNull
       List<Object> contexts,
       @Nullable
       String message,
       @Nullable
       Throwable throwable)

Description copied from interface: Log

Logs a warning message.

Specified by:

wrn in interface Log

Parameters:

contexts - the list of contexts.

message - the message.

throwable - the optional throwable or null.