Package org.junit.runner.notification
Class RunNotifier
- java.lang.Object
-
- org.junit.runner.notification.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 theRunNotifier
passed 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
RunNotifier.SafeNotifier
-
Field Summary
Fields Modifier and Type Field Description private java.util.List<RunListener>
listeners
private boolean
pleaseStop
-
Constructor Summary
Constructors Constructor Description RunNotifier()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFirstListener(RunListener listener)
Internal use only.void
addListener(RunListener listener)
Internal use onlyvoid
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.private void
fireTestFailures(java.util.List<RunListener> listeners, java.util.List<Failure> failures)
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(package private) RunListener
wrapIfNotThreadSafe(RunListener listener)
Wraps the given listener withSynchronizedRunListener
if it is not annotated withRunListener.ThreadSafe
.
-
-
-
Field Detail
-
listeners
private final java.util.List<RunListener> listeners
-
pleaseStop
private volatile boolean pleaseStop
-
-
Method Detail
-
addListener
public void addListener(RunListener listener)
Internal use only
-
removeListener
public void removeListener(RunListener listener)
Internal use only
-
wrapIfNotThreadSafe
RunListener wrapIfNotThreadSafe(RunListener listener)
Wraps the given listener withSynchronizedRunListener
if it is not annotated withRunListener.ThreadSafe
.
-
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
-
fireTestFailures
private void fireTestFailures(java.util.List<RunListener> listeners, java.util.List<Failure> failures)
-
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 theAssumptionViolatedException
thrown
-
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 theRunNotifier
is 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.
-
-