org.junit.runner.notification

Class RunNotifier


public class RunNotifier
extends java.lang.Object

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 Runner.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.

Method Summary

void
addFirstListener(RunListener listener)
Internal use only.
void
addListener(RunListener listener)
Internal use only
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
void
testAborted(Description description, Throwable cause)

Method Details

addFirstListener

public void addFirstListener(RunListener listener)
Internal use only. The Result's listener must be first.

addListener

public void addListener(RunListener listener)
Internal use only

fireTestFailure

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

fireTestFinished

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

fireTestIgnored

public void fireTestIgnored(Description description)
Invoke to tell listeners that an atomic test was ignored.
Parameters:
description - the description of the ignored test

fireTestRunFinished

public void fireTestRunFinished(Result result)
Do not invoke.

fireTestRunStarted

public void fireTestRunStarted(Description description)
Do not invoke.

fireTestStarted

public void fireTestStarted(Description description)
            throws StoppedByUserException
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

pleaseStop

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.

removeListener

public void removeListener(RunListener listener)
Internal use only

testAborted

public void testAborted(Description description,
                        Throwable cause)