NotYetImplemented (Groovy 5.0.0)
Description: declaration: package: groovy.test, annotation type: NotYetImplemented

Package groovy.test

# Annotation Type NotYetImplemented

@Documented @Retention(RUNTIME) @Target(METHOD) public @interface NotYetImplemented
Method annotation used to invert test case results. If a JUnit 3/4/5 test case method is annotated with `@NotYetImplemented`, the test will fail if no test failure occurs and it will pass if a test failure occurs.

This is helpful for tests that don't currently work but should work one day, when the tested functionality has been implemented.

Note: JUnit 3 users should use the optional `exception` attribute, e.g. `@NotYetImplemented(exception=junit.framework.AssertionFailedError)`.

Since:
  3.0.0

- ## Optional Element Summary

  Optional Elements
  Modifier and Type
  Optional Element
  Description
  `Class<? extends AssertionError>`
  `exception`
  If defined, tests which unexpectedly pass will throw this exception.

- ## Element Details

  - ### exception

    Class<? extends AssertionError> exception
    If defined, tests which unexpectedly pass will throw this exception. The supplied exception class should have a constructor variant accepting a single String error message.
    Since:
      3.0.3
    Default:
      java.lang.AssertionError.class