Class RunnerBuilder

java.lang.Object
org.junit.runners.model.RunnerBuilder
Direct Known Subclasses:
AllDefaultPossibilitiesBuilder, AnnotatedBuilder, IgnoredBuilder, JUnit3Builder, JUnit4Builder, NullBuilder, SuiteMethodBuilder

public abstract class RunnerBuilder extends Object
A RunnerBuilder is a strategy for constructing runners for classes. Only writers of custom runners should use RunnerBuilders. A custom runner class with a constructor taking a RunnerBuilder parameter will be passed the instance of RunnerBuilder used to build that runner itself. For example, imagine a custom runner that builds suites based on a list of classes in a text file:
 \@RunWith(TextFileSuite.class)
 \@SuiteSpecFile("mysuite.txt")
 class MySuite {}
 
The implementation of TextFileSuite might include:
 public TextFileSuite(Class testClass, RunnerBuilder builder) {
   // ...
   for (String className : readClassNames())
     addRunner(builder.runnerForClass(Class.forName(className)));
   // ...
 }
 
Since:
4.5
See Also:
  • Field Details

    • parents

      private final Set<Class<?>> parents
  • Constructor Details

    • RunnerBuilder

      public RunnerBuilder()
  • Method Details

    • runnerForClass

      public abstract Runner runnerForClass(Class<?> testClass) throws Throwable
      Override to calculate the correct runner for a test class at runtime.
      Parameters:
      testClass - class to be run
      Returns:
      a Runner
      Throws:
      Throwable - if a runner cannot be constructed
    • safeRunnerForClass

      public Runner safeRunnerForClass(Class<?> testClass)
      Always returns a runner for the given test class.

      In case of an exception a runner will be returned that prints an error instead of running tests.

      Note that some of the internal JUnit implementations of RunnerBuilder will return null from this method, but no RunnerBuilder passed to a Runner constructor will return null from this method.

      Parameters:
      testClass - class to be run
      Returns:
      a Runner
    • configureRunner

      private void configureRunner(Runner runner) throws InvalidOrderingException
      Throws:
      InvalidOrderingException
    • addParent

      Class<?> addParent(Class<?> parent) throws InitializationError
      Throws:
      InitializationError
    • removeParent

      void removeParent(Class<?> klass)
    • runners

      public List<Runner> runners(Class<?> parent, Class<?>[] children) throws InitializationError
      Constructs and returns a list of Runners, one for each child class in children. Care is taken to avoid infinite recursion: this builder will throw an exception if it is requested for another runner for parent before this call completes.
      Throws:
      InitializationError
    • runners

      public List<Runner> runners(Class<?> parent, List<Class<?>> children) throws InitializationError
      Throws:
      InitializationError
    • runners

      private List<Runner> runners(Class<?>[] children)