com.github.dm.jrt.log

Interface Log

All Known Implementing Classes:

NullLog, SystemLog, TemplateLog

public interface Log

Interface defining a log object responsible for formatting and writing the log messages.

A default log instance can be set by invoking the proper logger methods. Note, however, that a routine instance cannot dynamically change its log after creation.

Note also that a log instance is typically accessed from different threads, so, it is responsibility of the implementing class to avoid concurrency issues by synchronizing mutable fields when required.

To avoid an excessive number of log messages, it is sufficient to set an higher log level. Though, it is also possible to completely remove the log source code (and related strings) from the released code by using Proguard and adding, for example, the following rule to the configuration file:

     

         -assumenosideeffects class com.github.dm.jrt.log.Logger {
             public void dbg(...);
         }
     
 

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

See Also:

Logger

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Log.Level Log levels enumeration from more to less verbose.

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.
void	wrn(List<Object> contexts, String message, Throwable throwable) Logs a warning message.

Method Detail

dbg

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

Logs a debug message.

Parameters:

contexts - the list of contexts.

message - the message.

throwable - the optional throwable or null.

err

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

Logs an error message.

Parameters:

contexts - the list of contexts.

message - the message.

throwable - the optional throwable or null.

wrn

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

Logs a warning message.

Parameters:

contexts - the list of contexts.

message - the message.

throwable - the optional throwable or null.