timber.log

Class Tree

java.lang.Object

timber.log.Tree

Direct Known Subclasses:

DebugTree, FileTree

public abstract class Tree
extends Object

A facade for handling logging calls. Install instances via Timber.plant().

Field Summary

Fields

Modifier and Type	Field and Description
protected String	NL

Constructor Summary

Constructors

Constructor and Description
Tree()

Method Summary

Modifier and Type	Method and Description
protected String	createStackElementTag(StackTraceElement element) Extract the tag which should be used for the message from the element.
void	debug(String message, Object... args) Log a debug message with optional format args.
void	debug(Throwable t, String message, Object... args) Log a debug exception and a message with optional format args.
void	error(String message, Object... args) Log an error message with optional format args.
void	error(Throwable t, String message, Object... args) Log an error exception and a message with optional format args.
void	fatal(String message, Object... args) Log a fatal message with optional format args.
void	fatal(Throwable t, String message, Object... args) Log a fatal exception and a message with optional format args.
protected String	formatLine(Level level, String tag, String message)
protected String	getStackTraceString(Throwable t)
protected String	getTag()
void	info(String message, Object... args) Log an info message with optional format args.
void	info(Throwable t, String message, Object... args) Log an info exception and a message with optional format args.
protected boolean	isLoggeable(Level level) Return whether a message at level should be logged.
void	log(Level level, String message, Object... args) Log at level a message with optional format args.
protected abstract void	log(Level level, String tag, String message, Throwable t) Write a log message to its destination.
void	log(Level level, Throwable t, String message, Object... args) Log at level an exception and a message with optional format args.
protected void	prepareLog(Level level, Throwable t, String message, Object... args)
void	setDateFormatPattern(String pattern)
void	trace(String message, Object... args) Log a trace message with optional format args.
void	trace(Throwable t, String message, Object... args) Log a trace exception and a message with optional format args.
void	warn(String message, Object... args) Log a warn message with optional format args.
void	warn(Throwable t, String message, Object... args) Log a warn exception and a message with optional format args.

Methods inherited from class java.lang.Object

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

Field Detail

NL

protected final String NL

Constructor Detail

Tree

public Tree()

Method Detail

getTag

protected String getTag()

trace

public void trace(String message,
                  Object... args)

Log a trace message with optional format args.

trace

public void trace(Throwable t,
                  String message,
                  Object... args)

Log a trace exception and a message with optional format args.

debug

public void debug(String message,
                  Object... args)

Log a debug message with optional format args.

debug

public void debug(Throwable t,
                  String message,
                  Object... args)

Log a debug exception and a message with optional format args.

info

public void info(String message,
                 Object... args)

Log an info message with optional format args.

info

public void info(Throwable t,
                 String message,
                 Object... args)

Log an info exception and a message with optional format args.

warn

public void warn(String message,
                 Object... args)

Log a warn message with optional format args.

warn

public void warn(Throwable t,
                 String message,
                 Object... args)

Log a warn exception and a message with optional format args.

error

public void error(String message,
                  Object... args)

Log an error message with optional format args.

error

public void error(Throwable t,
                  String message,
                  Object... args)

Log an error exception and a message with optional format args.

fatal

public void fatal(String message,
                  Object... args)

Log a fatal message with optional format args.

fatal

public void fatal(Throwable t,
                  String message,
                  Object... args)

Log a fatal exception and a message with optional format args.

log

public void log(Level level,
                String message,
                Object... args)

Log at level a message with optional format args.

log

public void log(Level level,
                Throwable t,
                String message,
                Object... args)

Log at level an exception and a message with optional format args.

isLoggeable

protected boolean isLoggeable(Level level)

Return whether a message at level should be logged.

prepareLog

protected void prepareLog(Level level,
                          Throwable t,
                          String message,
                          Object... args)

getStackTraceString

protected final String getStackTraceString(Throwable t)

createStackElementTag

protected String createStackElementTag(StackTraceElement element)

Extract the tag which should be used for the message from the element. By default this will use the class name without any anonymous class suffixes (e.g., Foo$1 becomes Foo).

Note: This will not be called if a manual tag was specified.

formatLine

protected String formatLine(Level level,
                            String tag,
                            String message)

setDateFormatPattern

public final void setDateFormatPattern(String pattern)

log

protected abstract void log(Level level,
                            String tag,
                            String message,
                            Throwable t)

Write a log message to its destination. Called for all level-specific methods by default.

Parameters:

level - Log level. See Level for constants.

tag - Explicit or inferred tag. May be null.

message - Formatted log message. May be null, but then t will not be.

t - Accompanying exceptions. May be null, but then message will not be.