public class

BlockJUnit4ClassRunner

extends ParentRunner<T>
java.lang.Object
   ↳ org.junit.runner.Runner
     ↳ org.junit.runners.ParentRunner<T>
       ↳ org.junit.runners.BlockJUnit4ClassRunner
Known Direct Subclasses

Class Overview

Implements the JUnit 4 standard test case class model, as defined by the annotations in the org.junit package. Many users will never notice this class: it is now the default test class runner, but it should have exactly the same behavior as the old test class runner (JUnit4ClassRunner). BlockJUnit4ClassRunner has advantages for writers of custom JUnit runners that are slight changes to the default behavior, however:

  • It has a much simpler implementation based on Statements, allowing new operations to be inserted into the appropriate point in the execution flow.
  • It is published, and extension and reuse are encouraged, whereas JUnit4ClassRunner was in an internal package, and is now deprecated.

Summary

Public Constructors
BlockJUnit4ClassRunner(Class<?> klass)
Creates a BlockJUnit4ClassRunner to run klass
Protected Methods
void collectInitializationErrors(List<Throwable> errors)
Adds to errors a throwable for each problem noted with the test class (available from getTestClass()).
List<FrameworkMethod> computeTestMethods()
Returns the methods that run tests.
Object createTest()
Returns a new fixture for running a test.
Description describeChild(FrameworkMethod method)
Returns a Description for child, which can be assumed to be an element of the list returned by getChildren()
List<FrameworkMethod> getChildren()
Returns a list of objects that define the children of this Runner.
Statement methodBlock(FrameworkMethod method)
Returns a Statement that, when executed, either returns normally if method passes, or throws an exception if method fails.
Statement methodInvoker(FrameworkMethod method, Object test)
Returns a Statement that invokes method on test
Statement possiblyExpectingExceptions(FrameworkMethod method, Object test, Statement next)
This method is deprecated. Will be private soon: use Rules instead
void runChild(FrameworkMethod method, RunNotifier notifier)
Runs the test corresponding to child, which can be assumed to be an element of the list returned by getChildren().
String testName(FrameworkMethod method)
Returns the name that describes method for Descriptions.
void validateConstructor(List<Throwable> errors)
Adds to errors if the test class has more than one constructor, or if the constructor takes parameters.
void validateInstanceMethods(List<Throwable> errors)
This method is deprecated. unused API, will go away in future version
void validateOnlyOneConstructor(List<Throwable> errors)
Adds to errors if the test class has more than one constructor (do not override)
void validateTestMethods(List<Throwable> errors)
Adds to errors for each method annotated with @Testthat is not a public, void instance method with no arguments.
void validateZeroArgConstructor(List<Throwable> errors)
Adds to errors if the test class's single constructor takes parameters (do not override)
Statement withAfters(FrameworkMethod method, Object target, Statement statement)
This method is deprecated. Will be private soon: use Rules instead
Statement withBefores(FrameworkMethod method, Object target, Statement statement)
This method is deprecated. Will be private soon: use Rules instead
Statement withPotentialTimeout(FrameworkMethod method, Object test, Statement next)
This method is deprecated. Will be private soon: use Rules instead
[Expand]
Inherited Methods
From class org.junit.runners.ParentRunner
From class org.junit.runner.Runner
From class java.lang.Object
From interface org.junit.runner.Describable
From interface org.junit.runner.manipulation.Filterable
From interface org.junit.runner.manipulation.Sortable

Public Constructors

public BlockJUnit4ClassRunner (Class<?> klass)

Creates a BlockJUnit4ClassRunner to run klass

Throws
InitializationError if the test class is malformed.

Protected Methods

protected void collectInitializationErrors (List<Throwable> errors)

Adds to errors a throwable for each problem noted with the test class (available from getTestClass()). Default implementation adds an error for each method annotated with @BeforeClass or @AfterClass that is not public static void with no arguments.

protected List<FrameworkMethod> computeTestMethods ()

Returns the methods that run tests. Default implementation returns all methods annotated with @Test on this class and superclasses that are not overridden.

protected Object createTest ()

Returns a new fixture for running a test. Default implementation executes the test class's no-argument constructor (validation should have ensured one exists).

Throws
Exception

protected Description describeChild (FrameworkMethod method)

Returns a Description for child, which can be assumed to be an element of the list returned by getChildren()

protected List<FrameworkMethod> getChildren ()

Returns a list of objects that define the children of this Runner.

protected Statement methodBlock (FrameworkMethod method)

Returns a Statement that, when executed, either returns normally if method passes, or throws an exception if method fails. Here is an outline of the default implementation:

  • Invoke method on the result of createTest(), and throw any exceptions thrown by either operation.
  • HOWEVER, if method's @Test annotation has the expecting attribute, return normally only if the previous step threw an exception of the correct type, and throw an exception otherwise.
  • HOWEVER, if method's @Test annotation has the timeout attribute, throw an exception if the previous step takes more than the specified number of milliseconds.
  • ALWAYS allow @Rule fields to modify the execution of the above steps. A Rule may prevent all execution of the above steps, or add additional behavior before and after, or modify thrown exceptions. For more information, see MethodRule
  • ALWAYS run all non-overridden @Before methods on this class and superclasses before any of the previous steps; if any throws an Exception, stop execution and pass the exception on.
  • ALWAYS run all non-overridden @After methods on this class and superclasses after any of the previous steps; all After methods are always executed: exceptions thrown by previous steps are combined, if necessary, with exceptions from After methods into a MultipleFailureException.
This can be overridden in subclasses, either by overriding this method, or the implementations creating each sub-statement.

protected Statement methodInvoker (FrameworkMethod method, Object test)

Returns a Statement that invokes method on test

protected Statement possiblyExpectingExceptions (FrameworkMethod method, Object test, Statement next)

This method is deprecated.
Will be private soon: use Rules instead

Returns a Statement: if method's @Test annotation has the expecting attribute, return normally only if next throws an exception of the correct type, and throw an exception otherwise.

protected void runChild (FrameworkMethod method, RunNotifier notifier)

Runs the test corresponding to child, which can be assumed to be an element of the list returned by getChildren(). Subclasses are responsible for making sure that relevant test events are reported through notifier

protected String testName (FrameworkMethod method)

Returns the name that describes method for Descriptions. Default implementation is the method's name

protected void validateConstructor (List<Throwable> errors)

Adds to errors if the test class has more than one constructor, or if the constructor takes parameters. Override if a subclass requires different validation rules.

protected void validateInstanceMethods (List<Throwable> errors)

This method is deprecated.
unused API, will go away in future version

Adds to errors for each method annotated with @Test, @Before, or @After that is not a public, void instance method with no arguments.

protected void validateOnlyOneConstructor (List<Throwable> errors)

Adds to errors if the test class has more than one constructor (do not override)

protected void validateTestMethods (List<Throwable> errors)

Adds to errors for each method annotated with @Testthat is not a public, void instance method with no arguments.

protected void validateZeroArgConstructor (List<Throwable> errors)

Adds to errors if the test class's single constructor takes parameters (do not override)

protected Statement withAfters (FrameworkMethod method, Object target, Statement statement)

This method is deprecated.
Will be private soon: use Rules instead

Returns a Statement: run all non-overridden @After methods on this class and superclasses before running next; all After methods are always executed: exceptions thrown by previous steps are combined, if necessary, with exceptions from After methods into a MultipleFailureException.

protected Statement withBefores (FrameworkMethod method, Object target, Statement statement)

This method is deprecated.
Will be private soon: use Rules instead

Returns a Statement: run all non-overridden @Before methods on this class and superclasses before running next; if any throws an Exception, stop execution and pass the exception on.

protected Statement withPotentialTimeout (FrameworkMethod method, Object test, Statement next)

This method is deprecated.
Will be private soon: use Rules instead

Returns a Statement: if method's @Test annotation has the timeout attribute, throw an exception if next takes more than the specified number of milliseconds.