io.vertx.ext.unit.report.Failure 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.GenIgnore;
import io.vertx.codegen.annotations.VertxGen;

/**
 * A failure provides the details of a failure that happened during the execution of a test case.
 *
 * The failure can be:
 * 

 *   an assertion failure: an assertion failed
 *   an error failure: an expected error occured
 * 
 *
 *
 * @author Julien Viet
 */
@VertxGen
public interface Failure {

  /**
   * @return true if the failure is an error failure otherwise it is an assertion failure
   */
  @CacheReturn
  boolean isError();

  /**
   * @return the error message
   */
  @CacheReturn
  String message();

  /**
   * @return the stack trace
   */
  @CacheReturn
  String stackTrace();

  /**
   * @return the underlying exception causing this failure, it may be null
   */
  @GenIgnore
  Throwable cause();

}