Filter (JUnit API)
Keywords: org.junit.runner.manipulation.Filter class

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.junit.runner.manipulation
Class Filter

    java.lang.Object
      org.junit.runner.manipulation.Filter

Direct Known Subclasses:
  Categories.CategoryFilter

    public abstract class Filter

extends Object

The canonical case of filtering is when you want to run a single test method in a class. Rather than introduce runner API just for that one case, JUnit provides a general filtering mechanism. If you want to filter the tests to be run, extend `Filter` and apply an instance of your filter to the `Request` before running it (see `JUnitCore.run(Request)`. Alternatively, apply a `Filter` to a `Runner` before running tests (for example, in conjunction with `RunWith`.

Field Summary
`static Filter` | `ALL` A null `Filter` that passes all tests through.

Constructor Summary
`Filter()`

Method Summary
`void` | `apply(Object child)` Invoke with a `Runner` to cause all tests it intends to run to first be checked with the filter.
`abstract String` | `describe()` Returns a textual description of this Filter
`static Filter` | `matchMethodDescription(Description desiredDescription)` Returns a `Filter` that only runs the single method described by `desiredDescription`
`abstract boolean` | `shouldRun(Description description)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### ALL

    public static Filter ALL

  A null `Filter` that passes all tests through.

Constructor Detail

### Filter

    public Filter()

Method Detail

### matchMethodDescription

    public static Filter matchMethodDescription(Description desiredDescription)

  Returns a `Filter` that only runs the single method described by `desiredDescription`

### shouldRun

    public abstract boolean shouldRun(Description description)

  Parameters:
    `description` - the description of the test to be run
  Returns:
    `true` if the test should be run

### describe

    public abstract String describe()

  Returns a textual description of this Filter

  Returns:
    a textual description of this Filter

### apply

    public void apply(Object child)
               throws NoTestsRemainException

  Invoke with a `Runner` to cause all tests it intends to run to first be checked with the filter. Only those that pass the filter will be run.

  Parameters:
    `child` - the runner to be filtered by the receiver
  Throws:
    `NoTestsRemainException` - if the receiver removes all tests

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD