io.vertx.ext.unit.report.TestSuiteReport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-unit Show documentation

There is a newer version: 5.0.0.CR3

package io.vertx.ext.unit.report;

import io.vertx.codegen.annotations.CacheReturn;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.Handler;
import io.vertx.core.streams.ReadStream;

/**
 * The test suite reports is basically a stream of events reporting the test suite execution.
 *
 * @author Julien Viet
 */
@VertxGen
public interface TestSuiteReport extends ReadStream {

  /**
   * @return the test suite name
   */
  @CacheReturn
  String name();

  /**
   * Set an exception handler, the exception handler reports the test suite errors, it can be called mulitple
   * times before the test ends.
   *
   * @param handler the exception handler
   * @return a reference to this, so the API can be used fluently
   */
  @Override
  TestSuiteReport exceptionHandler(Handler handler);

  @Override
  TestSuiteReport handler(Handler handler);

  @Override
  TestSuiteReport pause();

  @Override
  TestSuiteReport resume();

  @Override
  TestSuiteReport endHandler(Handler endHandler);

}