net.lachlanmckee.timberjunit

Class TimberTestRule

java.lang.Object

net.lachlanmckee.timberjunit.TimberTestRule

public class TimberTestRule
extends java.lang.Object

A JUnit TestRule that plants a Timber.Tree before a test is executed, and uproots the Timber.Tree afterwards.

This is useful as a planted Timber.Tree would exist between test classes, which may be undesirable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimberTestRule.Rules Defines a set of rules in which the TimberTestRule's internal Timber tree must adhere to when intercepting log messages.

Method Summary

Modifier and Type	Method and Description
Statement	apply(Statement base, Description description)
static TimberTestRule.Rules	builder()
static TimberTestRule	logAllAlways()
static TimberTestRule	logAllWhenTestFails()
static TimberTestRule	logErrorsAlways()
static TimberTestRule	logErrorsWhenTestFails()

Methods inherited from class java.lang.Object

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

Method Detail

logAllAlways

public static TimberTestRule logAllAlways()

Returns:

a TimberTestRule that logs messages of any priority regardless of the test outcome

logAllWhenTestFails

public static TimberTestRule logAllWhenTestFails()

Returns:

a TimberTestRule that logs all messages, regardless of their priority.

logErrorsAlways

public static TimberTestRule logErrorsAlways()

Returns:

a TimberTestRule that only logs error messages regardless of the test outcome.

logErrorsWhenTestFails

public static TimberTestRule logErrorsWhenTestFails()

Returns:

a TimberTestRule that only logs error messages when a unit test fails.

builder

public static TimberTestRule.Rules builder()

Returns:

a TimberTestRule.Rules class which is used as a builder to create a TimberTestRule.

apply

public Statement apply(Statement base,
                       Description description)