at.amartinz.universaldebug.trees

Class BaseTree

java.lang.Object

Timber.DebugTree

at.amartinz.universaldebug.trees.BaseTree

public class BaseTree
extends Timber.DebugTree

Base tree for use with Timber.
Allows to add and remove BaseTreeComponents dynamically

Constructor Summary

Constructors

Constructor and Description
BaseTree(android.content.Context applicationContext, java.util.Set<java.lang.Integer> priorityFilterList) Creates a BaseTree to be used with Timber.Tree#plant(Timber.Tree) .

Method Summary

Modifier and Type	Method and Description
BaseTree	addComponent(BaseTreeComponent baseTreeComponent) Adds a BaseTreeComponent which will receive events and be able to react with custom logic.
android.content.Context	getApplicationContext()
java.util.List<BaseTreeComponent>	getComponents()
protected void	log(int priority, java.lang.String tag, java.lang.String message, java.lang.Throwable t) DOES NOT ACTUALLY LOG!
static java.lang.String	mapPriorityToString(int priority) Maps a Log priority such as Log.INFO to a string.
void	reallyDoLog(int priority, java.lang.String tag, java.lang.String message, java.lang.Throwable t) Calls the DebugTree's log method.
BaseTree	removeComponent(BaseTreeComponent baseTreeComponent) Removes a BaseTreeComponent which then will not receive any events anymore.
BaseTree	removeComponent(java.lang.Class clazz)
BaseTree	setEnabled(boolean isEnabled) When disabled, no events will get forwarded.
boolean	shouldLog(int priority)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseTree

public BaseTree(@NonNull
                android.content.Context applicationContext,
                @NonNull
                java.util.Set<java.lang.Integer> priorityFilterList)

Creates a BaseTree to be used with Timber.Tree#plant(Timber.Tree) .

Parameters:

applicationContext - An application context

priorityFilterList - A Set of priorities to filter, provide an empty Set to allow any priority

Method Detail

setEnabled

public BaseTree setEnabled(boolean isEnabled)

When disabled, no events will get forwarded.
This can be used to prevent the overhead of shouldLog(int) calls.

Parameters:

isEnabled - Whether we should forward events or not

Returns:

The same BaseTree instance to allow chained calls

getApplicationContext

@NonNull
public android.content.Context getApplicationContext()

getComponents

@NonNull
public java.util.List<BaseTreeComponent> getComponents()

Returns:

A list of added BaseTreeComponents.

addComponent

public BaseTree addComponent(BaseTreeComponent baseTreeComponent)

Adds a BaseTreeComponent which will receive events and be able to react with custom logic.

Parameters:

baseTreeComponent - The BaseTreeComponent to add

Returns:

The same BaseTree instance to allow chained calls

removeComponent

public BaseTree removeComponent(BaseTreeComponent baseTreeComponent)

Removes a BaseTreeComponent which then will not receive any events anymore.

Parameters:

baseTreeComponent - The BaseTreeComponent to remove

Returns:

The same BaseTree instance to allow chained calls

removeComponent

public BaseTree removeComponent(java.lang.Class clazz)

See Also:

removeComponent(BaseTreeComponent)

log

protected void log(int priority,
                   java.lang.String tag,
                   java.lang.String message,
                   java.lang.Throwable t)

DOES NOT ACTUALLY LOG!
All log calls are getting forwarded to the added BaseTreeComponents.

See Also:

timber.log.Timber.Tree#log(int, String, String, Throwable)

reallyDoLog

public void reallyDoLog(int priority,
                        java.lang.String tag,
                        java.lang.String message,
                        java.lang.Throwable t)

Calls the DebugTree's log method.

See Also:

timber.log.Timber.DebugTree#log(int, String, String, Throwable)

shouldLog

public boolean shouldLog(int priority)

Parameters:

priority - The priority, which should be logged

Returns:

True, if we should log

mapPriorityToString

public static java.lang.String mapPriorityToString(int priority)

Maps a Log priority such as Log.INFO to a string.

Parameters:

priority - The log priority to map

Returns:

A string representation of the priority