Package org.junit.runner.notification

Class SynchronizedRunListener

java.lang.Object

org.junit.runner.notification.RunListener

org.junit.runner.notification.SynchronizedRunListener

@ThreadSafe
final class SynchronizedRunListener
extends RunListener

Thread-safe decorator for RunListener implementations that synchronizes calls to the delegate.

This class synchronizes all listener calls on a RunNotifier instance. This is done because prior to JUnit 4.12, all listeners were called in a synchronized block in RunNotifier, so no two listeners were ever called concurrently. If we instead made the methods here synchronized, clients that added multiple listeners that called common code might see issues due to the reduced synchronization.

Since:

4.12

See Also:

RunNotifier

Nested Class Summary

Nested classes/interfaces inherited from class org.junit.runner.notification.RunListener

RunListener.ThreadSafe

Field Summary

Fields

Modifier and Type	Field	Description
private RunListener	listener
private java.lang.Object	monitor

Constructor Summary

Constructors

Constructor	Description
SynchronizedRunListener(RunListener listener, java.lang.Object monitor)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)
int	hashCode()
void	testAssumptionFailure(Failure failure)	Called when an atomic test flags that it assumes a condition that is false
void	testFailure(Failure failure)	Called when an atomic test fails, or when a listener throws an exception.
void	testFinished(Description description)	Called when an atomic test has finished, whether the test succeeds or fails.
void	testIgnored(Description description)	Called when a test will not be run, generally because a test method is annotated with Ignore.
void	testRunFinished(Result result)	Called when all tests have finished.
void	testRunStarted(Description description)	Called before any tests have been run.
void	testStarted(Description description)	Called when an atomic test is about to be started.
void	testSuiteFinished(Description description)	Called when a test suite has finished, whether the test suite succeeds or fails.
void	testSuiteStarted(Description description)	Called when a test suite is about to be started.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

listener

private final RunListener listener

monitor

private final java.lang.Object monitor

Constructor Detail

SynchronizedRunListener

SynchronizedRunListener(RunListener listener,
                        java.lang.Object monitor)

Method Detail

testRunStarted

public void testRunStarted(Description description)
                    throws java.lang.Exception

Description copied from class: RunListener

Called before any tests have been run. This may be called on an arbitrary thread.

Overrides:

testRunStarted in class RunListener

Parameters:

description - describes the tests to be run

Throws:

java.lang.Exception

testRunFinished

public void testRunFinished(Result result)
                     throws java.lang.Exception

Description copied from class: RunListener

Called when all tests have finished. This may be called on an arbitrary thread.

Overrides:

testRunFinished in class RunListener

Parameters:

result - the summary of the test run, including all the tests that failed

Throws:

java.lang.Exception

testSuiteStarted

public void testSuiteStarted(Description description)
                      throws java.lang.Exception

Called when a test suite is about to be started. If this method is called for a given Description, then RunListener.testSuiteFinished(Description) will also be called for the same Description.

Note that not all runners will call this method, so runners should be prepared to handle RunListener.testStarted(Description) calls for tests where there was no corresponding testSuiteStarted() call for the parent Description.

Synchronized decorator for RunListener.testSuiteStarted(Description).

Overrides:

testSuiteStarted in class RunListener

Parameters:

description - the description of the test suite that is about to be run (generally a class name).

Throws:

java.lang.Exception - if any occurs.

Since:

4.13

testSuiteFinished

public void testSuiteFinished(Description description)
                       throws java.lang.Exception

Called when a test suite has finished, whether the test suite succeeds or fails. This method will not be called for a given Description unless RunListener.testSuiteStarted(Description) was called for the same @code Description}.

Synchronized decorator for RunListener.testSuiteFinished(Description).

Overrides:

testSuiteFinished in class RunListener

Parameters:

description - the description of the test suite that just ran.

Throws:

java.lang.Exception

Since:

4.13

testStarted

public void testStarted(Description description)
                 throws java.lang.Exception

Description copied from class: RunListener

Called when an atomic test is about to be started.

Overrides:

testStarted in class RunListener

Parameters:

description - the description of the test that is about to be run (generally a class and method name)

Throws:

java.lang.Exception

testFinished

public void testFinished(Description description)
                  throws java.lang.Exception

Description copied from class: RunListener

Called when an atomic test has finished, whether the test succeeds or fails.

Overrides:

testFinished in class RunListener

Parameters:

description - the description of the test that just ran

Throws:

java.lang.Exception

testFailure

public void testFailure(Failure failure)
                 throws java.lang.Exception

Description copied from class: RunListener

Called when an atomic test fails, or when a listener throws an exception.

In the case of a failure of an atomic test, this method will be called with the same Description passed to RunListener.testStarted(Description), from the same thread that called RunListener.testStarted(Description).

In the case of a listener throwing an exception, this will be called with a Description of Description.TEST_MECHANISM, and may be called on an arbitrary thread.

Overrides:

testFailure in class RunListener

Parameters:

failure - describes the test that failed and the exception that was thrown

Throws:

java.lang.Exception

testAssumptionFailure

public void testAssumptionFailure(Failure failure)

Description copied from class: RunListener

Called when an atomic test flags that it assumes a condition that is false

Overrides:

testAssumptionFailure in class RunListener

Parameters:

failure - describes the test that failed and the AssumptionViolatedException that was thrown

testIgnored

public void testIgnored(Description description)
                 throws java.lang.Exception

Description copied from class: RunListener

Called when a test will not be run, generally because a test method is annotated with Ignore.

Overrides:

testIgnored in class RunListener

Parameters:

description - describes the test that will not be run

Throws:

java.lang.Exception

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object