Ignore (JUnit API)

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT

## org.junit
Annotation Type Ignore

    @Retention(value=RUNTIME)
    @Target(value={METHOD,TYPE})
    public @interface Ignore

Sometimes you want to temporarily disable a test or a group of tests. Methods annotated with `Test` that are also annotated with `@Ignore` will not be executed as tests. Also, you can annotate a class containing test methods with `@Ignore` and none of the containing tests will be executed. Native JUnit 4 test runners should report the number of ignored tests along with the number of tests that ran and the number of tests that failed.

For example:

        @Ignore @Test public void something() { ...

@Ignore takes an optional default parameter if you want to record why a test is being ignored:

        @Ignore("not ready yet") @Test public void something() { ...

@Ignore can also be applied to the test class:

                    @Ignore public class IgnoreMe {
                            @Test public void test1() { ... }
                            @Test public void test2() { ... }
                    }

Optional Element Summary
`java.lang.String` | `value` The optional reason why the test is ignored.

### value

    public abstract java.lang.String value

  The optional reason why the test is ignored.

  Default:
    ""

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT