Package org.junit.runner.notification
Class RunNotifier
- java.lang.Object
- org.junit.runner.notification.RunNotifier
public class RunNotifier extends Object
If you write custom runners, you may need to notify JUnit of your progress running tests. Do this by invoking theRunNotifierpassed to your implementation ofRunner.run(RunNotifier). Future evolution of this class is likely to movefireTestRunStarted(Description)andfireTestRunFinished(Result)to a separate class since they should only be called once per run.- Since:
- 4.0
Constructor Summary
Constructors Constructor Description RunNotifier()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddFirstListener(RunListener listener)Internal use only.voidaddListener(RunListener listener)Internal use onlyvoidfireTestAssumptionFailed(Failure failure)Invoke to tell listeners that an atomic test flagged that it assumed something false.voidfireTestFailure(Failure failure)Invoke to tell listeners that an atomic test failed.voidfireTestFinished(Description description)Invoke to tell listeners that an atomic test finished.voidfireTestIgnored(Description description)Invoke to tell listeners that an atomic test was ignored.voidfireTestRunFinished(Result result)Do not invoke.voidfireTestRunStarted(Description description)Do not invoke.voidfireTestStarted(Description description)Invoke to tell listeners that an atomic test is about to start.voidpleaseStop()Ask that the tests run stop before starting the next test.voidremoveListener(RunListener listener)Internal use only
Constructor Detail
RunNotifier
public RunNotifier()
Method Detail
addListener
public void addListener(RunListener listener)
Internal use only
removeListener
public void removeListener(RunListener listener)
Internal use only
fireTestRunStarted
public void fireTestRunStarted(Description description)
Do not invoke.
fireTestRunFinished
public void fireTestRunFinished(Result result)
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
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
fireTestAssumptionFailed
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 theAssumptionViolatedExceptionthrown
fireTestIgnored
public void fireTestIgnored(Description description)
Invoke to tell listeners that an atomic test was ignored.- Parameters:
description- the description of the ignored test
fireTestFinished
public void fireTestFinished(Description description)
Invoke to tell listeners that an atomic test finished. Always invoke this method if you invokefireTestStarted(Description)as listeners are likely to expect them to come in pairs.- Parameters:
description- the description of the test that finished
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 theRunNotifieris the only object guaranteed to be shared amongst the many runners involved.
addFirstListener
public void addFirstListener(RunListener listener)
Internal use only. The Result's listener must be first.