org.junit.runners
Class ParentRunner<T>

java.lang.Object
  extended by org.junit.runner.Runner
      extended by org.junit.runners.ParentRunner<T>
All Implemented Interfaces:
Describable, Filterable, Sortable
Direct Known Subclasses:
BlockJUnit4ClassRunner, Suite

public abstract class ParentRunner<T>
extends Runner
implements Filterable, Sortable

Provides most of the functionality specific to a Runner that implements a "parent node" in the test tree, with children defined by objects of some data type T. (For BlockJUnit4ClassRunner, T is Method . For Suite, T is Class.) Subclasses must implement finding the children of the node, describing each child, and running each child. ParentRunner will filter and sort children, handle @BeforeClass and @AfterClass methods, create a composite Description, and run children sequentially.


Constructor Summary
protected ParentRunner(java.lang.Class<?> testClass)
          Constructs a new ParentRunner that will run @TestClass
 
Method Summary
protected  org.junit.runners.model.Statement childrenInvoker(RunNotifier notifier)
          Returns a Statement: Call runChild(Object, RunNotifier) on each object returned by getChildren() (subject to any imposed filter and sort)
protected  org.junit.runners.model.Statement classBlock(RunNotifier notifier)
          Constructs a Statement to run all of the tests in the test class.
protected  void collectInitializationErrors(java.util.List<java.lang.Throwable> errors)
          Adds to errors a throwable for each problem noted with the test class (available from getTestClass()).
protected abstract  Description describeChild(T child)
          Returns a Description for child, which can be assumed to be an element of the list returned by getChildren()
 void filter(Filter filter)
          Remove tests that don't pass the parameter filter.
protected abstract  java.util.List<T> getChildren()
          Returns a list of objects that define the children of this Runner.
 Description getDescription()
           
protected  java.lang.String getName()
          Returns a name used to describe this Runner
protected  org.junit.runners.model.TestClass getTestClass()
          Returns a TestClass object wrapping the class to be executed.
 void run(RunNotifier notifier)
          Run the tests for this runner.
protected abstract  void runChild(T child, RunNotifier notifier)
          Runs the test corresponding to child, which can be assumed to be an element of the list returned by getChildren().
 void sort(Sorter sorter)
          Sorts the tests using sorter
protected  void validatePublicVoidNoArgMethods(java.lang.Class<? extends java.lang.annotation.Annotation> annotation, boolean isStatic, java.util.List<java.lang.Throwable> errors)
          Adds to errors if any method in this class is annotated with annotation, but: is not public, or takes parameters, or returns something other than void, or is static (given isStatic is false), or is not static (given isStatic is true).
protected  org.junit.runners.model.Statement withAfterClasses(org.junit.runners.model.Statement statement)
          Returns a Statement: run all non-overridden @AfterClass methods on this class and superclasses before executing statement; all AfterClass methods are always executed: exceptions thrown by previous steps are combined, if necessary, with exceptions from AfterClass methods into a MultipleFailureException.
protected  org.junit.runners.model.Statement withBeforeClasses(org.junit.runners.model.Statement statement)
          Returns a Statement: run all non-overridden @BeforeClass methods on this class and superclasses before executing statement; if any throws an Exception, stop execution and pass the exception on.
 
Methods inherited from class org.junit.runner.Runner
testCount
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParentRunner

protected ParentRunner(java.lang.Class<?> testClass)
                throws org.junit.runners.model.InitializationError
Constructs a new ParentRunner that will run @TestClass

Throws:
org.junit.runners.model.InitializationError
Method Detail

getChildren

protected abstract java.util.List<T> getChildren()
Returns a list of objects that define the children of this Runner.


describeChild

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


runChild

protected abstract void runChild(T child,
                                 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


collectInitializationErrors

protected void collectInitializationErrors(java.util.List<java.lang.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.


validatePublicVoidNoArgMethods

protected void validatePublicVoidNoArgMethods(java.lang.Class<? extends java.lang.annotation.Annotation> annotation,
                                              boolean isStatic,
                                              java.util.List<java.lang.Throwable> errors)
Adds to errors if any method in this class is annotated with annotation, but:

classBlock

protected org.junit.runners.model.Statement classBlock(RunNotifier notifier)
Constructs a Statement to run all of the tests in the test class. Override to add pre-/post-processing. Here is an outline of the implementation:

Parameters:
notifier -
Returns:
Statement

withBeforeClasses

protected org.junit.runners.model.Statement withBeforeClasses(org.junit.runners.model.Statement statement)
Returns a Statement: run all non-overridden @BeforeClass methods on this class and superclasses before executing statement; if any throws an Exception, stop execution and pass the exception on.


withAfterClasses

protected org.junit.runners.model.Statement withAfterClasses(org.junit.runners.model.Statement statement)
Returns a Statement: run all non-overridden @AfterClass methods on this class and superclasses before executing statement; all AfterClass methods are always executed: exceptions thrown by previous steps are combined, if necessary, with exceptions from AfterClass methods into a MultipleFailureException.


childrenInvoker

protected org.junit.runners.model.Statement childrenInvoker(RunNotifier notifier)
Returns a Statement: Call runChild(Object, RunNotifier) on each object returned by getChildren() (subject to any imposed filter and sort)


getName

protected java.lang.String getName()
Returns a name used to describe this Runner


getTestClass

protected final org.junit.runners.model.TestClass getTestClass()
Returns a TestClass object wrapping the class to be executed.


getDescription

public Description getDescription()
Specified by:
getDescription in interface Describable
Specified by:
getDescription in class Runner
Returns:
a Description showing the tests to be run by the receiver

run

public void run(RunNotifier notifier)
Description copied from class: Runner
Run the tests for this runner.

Specified by:
run in class Runner
Parameters:
notifier - will be notified of events while tests are being run--tests being started, finishing, and failing

filter

public void filter(Filter filter)
            throws NoTestsRemainException
Description copied from interface: Filterable
Remove tests that don't pass the parameter filter.

Specified by:
filter in interface Filterable
Parameters:
filter - the Filter to apply
Throws:
NoTestsRemainException - if all tests are filtered out

sort

public void sort(Sorter sorter)
Description copied from interface: Sortable
Sorts the tests using sorter

Specified by:
sort in interface Sortable
Parameters:
sorter - the Sorter to use for sorting the tests