public class

RunNotifier

extends Object
java.lang.Object
   ↳ org.junit.runner.notification.RunNotifier

Class Overview

If you write custom runners, you may need to notify JUnit of your progress running tests. Do this by invoking the RunNotifier passed to your implementation of run(RunNotifier). Future evolution of this class is likely to move fireTestRunStarted(Description) and fireTestRunFinished(Result) to a separate class since they should only be called once per run.

Summary

Public Constructors
RunNotifier()
Public Methods
void addFirstListener(RunListener listener)
Internal use only.
void addListener(RunListener listener)
Internal use only
void fireTestAssumptionFailed(Failure failure)
Invoke to tell listeners that an atomic test flagged that it assumed something false.
void fireTestFailure(Failure failure)
Invoke to tell listeners that an atomic test failed.
void fireTestFinished(Description description)
Invoke to tell listeners that an atomic test finished.
void fireTestIgnored(Description description)
Invoke to tell listeners that an atomic test was ignored.
void fireTestRunFinished(Result result)
Do not invoke.
void fireTestRunStarted(Description description)
Do not invoke.
void fireTestStarted(Description description)
Invoke to tell listeners that an atomic test is about to start.
void pleaseStop()
Ask that the tests run stop before starting the next test.
void removeListener(RunListener listener)
Internal use only
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RunNotifier ()

Public Methods

public void addFirstListener (RunListener listener)

Internal use only. The Result's listener must be first.

public void addListener (RunListener listener)

Internal use only

public void fireTestAssumptionFailed (Failure failure)

Invoke to tell listeners that an atomic test flagged that it assumed something false.

Parameters
failure the description of the test that failed and the AssumptionViolatedException thrown

public void fireTestFailure (Failure failure)

Invoke to tell listeners that an atomic test failed.

Parameters
failure the description of the test that failed and the exception thrown

public void fireTestFinished (Description description)

Invoke to tell listeners that an atomic test finished. Always invoke fireTestFinished(Description) if you invoke fireTestStarted(Description) as listeners are likely to expect them to come in pairs.

Parameters
description the description of the test that finished

public void fireTestIgnored (Description description)

Invoke to tell listeners that an atomic test was ignored.

Parameters
description the description of the ignored test

public void fireTestRunFinished (Result result)

Do not invoke.

public void fireTestRunStarted (Description description)

Do not invoke.

public void fireTestStarted (Description description)

Invoke to tell listeners that an atomic test is about to start.

Parameters
description the description of the atomic test (generally a class and method name)
Throws
StoppedByUserException thrown if a user has requested that the test run stop

public void pleaseStop ()

Ask that the tests run stop before starting the next test. Phrased politely because the test currently running will not be interrupted. It seems a little odd to put this functionality here, but the RunNotifier is the only object guaranteed to be shared amongst the many runners involved.

public void removeListener (RunListener listener)

Internal use only