Package org.assertj.core.api

Class Fail

java.lang.Object
org.assertj.core.api.Fail
public final class Fail extends Object
Common failures.
Author:
Alex Ruiz, Yvonne Wang, Joel Costigliola

  • Method Details

    • setRemoveAssertJRelatedElementsFromStackTrace

      public static void setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace)
      Sets whether we remove elements related to AssertJ from assertion error stack trace.
      Parameters:
      removeAssertJRelatedElementsFromStackTrace - flag.

    • fail

      @Contract("_ -> fail") public static <T> T fail(String failureMessage)
      Throws an AssertionError with the given message.
      Type Parameters:
      T - dummy return value type
      Parameters:
      failureMessage - error message.
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> fail("boom")));.
      Throws:
      AssertionError - with the given message.

    • fail

      @Contract(" -> fail") public static <T> T fail()
      Throws an AssertionError with an empty message to be used in code like: 
       doSomething(optional.orElseGet(() -> fail()));
      Type Parameters:
      T - dummy return value type
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> fail()));.
      Throws:
      AssertionError - with an empty message.
      Since:
      3.26.0

    • fail

      @Contract("_, _ -> fail") public static <T> T fail(String failureMessage, Object... args)
      Throws an AssertionError with the given message built as String.format(String, Object...).
      Type Parameters:
      T - dummy return value type
      Parameters:
      failureMessage - error message.
      args - Arguments referenced by the format specifiers in the format string.
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> fail("b%s", ""oom)));.
      Throws:
      AssertionError - with the given built message.

    • fail

      @Contract("_, _ -> fail") public static <T> T fail(String failureMessage, Throwable realCause)
      Throws an AssertionError with the given message and with the Throwable that caused the failure.
      Type Parameters:
      T - dummy return value type
      Parameters:
      failureMessage - the description of the failed assertion. It can be null.
      realCause - cause of the error.
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> fail("boom", cause)));.
      Throws:
      AssertionError - with the given message and with the Throwable that caused the failure.

    • fail

      @Contract("_ -> fail") public static <T> T fail(Throwable realCause)
      Throws an AssertionError with the Throwable that caused the failure.
      Type Parameters:
      T - dummy return value type
      Parameters:
      realCause - cause of the error.
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> fail(cause)));.
      Throws:
      AssertionError - with the Throwable that caused the failure.

    • failBecauseExceptionWasNotThrown

      @Contract("_ -> fail") public static <T> T failBecauseExceptionWasNotThrown(Class<? extends Throwable> throwableClass)
      Throws an AssertionError with a message explaining that a Throwable of given class was expected to be thrown but had not been.
      Type Parameters:
      T - dummy return value type
      Parameters:
      throwableClass - the Throwable class that was expected to be thrown.
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> failBecauseExceptionWasNotThrown(IOException.class)));.
      Throws:
      AssertionError - with a message explaining that a Throwable of given class was expected to be thrown but had not been.
      See Also:

    • shouldHaveThrown

      @Contract("_ -> fail") public static <T> T shouldHaveThrown(Class<? extends Throwable> throwableClass)
      Throws an AssertionError with a message explaining that a Throwable of given class was expected to be thrown but had not been.
      Type Parameters:
      T - dummy return value type
      Parameters:
      throwableClass - the Throwable class that was expected to be thrown.
      Returns:
      nothing, it's just to be used in doSomething(optional.orElseGet(() -> shouldHaveThrown(IOException.class)));.
      Throws:
      AssertionError - with a message explaining that a Throwable of given class was expected to be thrown but had not been.