net.lachlanmckee.timberjunit

Class TimberTestRule.Rules

java.lang.Object

net.lachlanmckee.timberjunit.TimberTestRule.Rules

Enclosing class:

TimberTestRule

public static final class TimberTestRule.Rules
extends java.lang.Object

Defines a set of rules in which the TimberTestRule's internal Timber tree must adhere to when intercepting log messages.

The types of rules applied are:

1. Min priority - What is the lowest level of log type that should be logged.
2. Show thread - Whether the Thread ID and name should be logged.
3. Show timestamp - Whether the current time should be logged.

Method Summary

Modifier and Type	Method and Description
TimberTestRule	build() Builds the JUnit test rule based on the defined rules.
TimberTestRule.Rules	minPriority(int minPriority) Defines what the lowest level of log type that should be logged.
TimberTestRule.Rules	onlyLogWhenTestFails(boolean onlyLogWhenTestFails) Defines whether the logs are only output if the unit test fails.
TimberTestRule.Rules	showThread(boolean showThread) Defines whether the Thread ID and name should be logged
TimberTestRule.Rules	showTimestamp(boolean showTimestamp) Defines whether the timestamp should be logged

Methods inherited from class java.lang.Object

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

Method Detail

minPriority

public TimberTestRule.Rules minPriority(int minPriority)

Defines what the lowest level of log type that should be logged.

This can be:

1. Log.VERBOSE
2. Log.DEBUG
3. Log.INFO
4. Log.WARN
5. Log.ERROR

Parameters:

minPriority - the Android log priority.

Returns:

the mutated TimberTestRule.Rules

showThread

public TimberTestRule.Rules showThread(boolean showThread)

Defines whether the Thread ID and name should be logged

Parameters:

showThread - whether the thread details are shown.

Returns:

the mutated TimberTestRule.Rules

showTimestamp

public TimberTestRule.Rules showTimestamp(boolean showTimestamp)

Defines whether the timestamp should be logged

Parameters:

showTimestamp - whether the timestamp is shown.

Returns:

the mutated TimberTestRule.Rules

onlyLogWhenTestFails

public TimberTestRule.Rules onlyLogWhenTestFails(boolean onlyLogWhenTestFails)

Defines whether the logs are only output if the unit test fails.

Parameters:

onlyLogWhenTestFails - whether the logs are only output when a test fails.

Returns:

the mutated TimberTestRule.Rules

build

public TimberTestRule build()

Builds the JUnit test rule based on the defined rules.

Returns:

a new JUnit test rule instance.