Package org.assertj.core.api

Interface AssertionErrorCollector

All Superinterfaces:
AfterAssertionErrorCollected
All Known Subinterfaces:
AutoCloseableSoftAssertionsProvider, BDDSoftAssertionsProvider, Java6BDDSoftAssertionsProvider, Java6StandardSoftAssertionsProvider, SoftAssertionsProvider, SoftAssertionsRule, StandardSoftAssertionsProvider
All Known Implementing Classes:
AbstractSoftAssertions, AutoCloseableBDDSoftAssertions, AutoCloseableSoftAssertions, BDDSoftAssertions, DefaultAssertionErrorCollector, Java6BDDSoftAssertions, Java6JUnitBDDSoftAssertions, Java6JUnitSoftAssertions, Java6SoftAssertions, JUnitBDDSoftAssertions, JUnitJupiterBDDSoftAssertions, JUnitJupiterSoftAssertions, JUnitSoftAssertions, SoftAssertions
public interface AssertionErrorCollector extends AfterAssertionErrorCollected

  • Method Details

    • setDelegate

      default void setDelegate(AssertionErrorCollector delegate)
      Optionally sets a "delegate" collector into which the collected assertions will be deposited.

      Note that if you set a delegate, this instance will no longer collect or report assertion errors itself but will forward them all to the delegate for collection.

      Parameters:
      delegate - the AssertionErrorCollector to which the assertions will be forwarded.

    • getDelegate

      default Optional<AssertionErrorCollector> getDelegate()

    • collectAssertionError

      void collectAssertionError(AssertionError error)
      This method can be used to collect soft assertion errors.

      To be able to react after an assertion error is collected, use onAssertionErrorCollected(AssertionError).

      Parameters:
      error - the AssertionError to collect.

    • assertionErrorsCollected

      List<AssertionError> assertionErrorsCollected()

    • onAssertionErrorCollected

      default void onAssertionErrorCollected(AssertionError assertionError)
      Description copied from interface: AfterAssertionErrorCollected
      This method is called after each AssertionError is collected by soft assertions (you can't prevent the error to be collected).

      SoftAssertionsProvider provides a do-nothing implementation which you can override in your own custom soft assertions class.
      Note that your custom soft assertions class must extend AbstractSoftAssertions as this is where the actual soft assertion errors collection is implemented.

      If you just use the standard soft assertions classes provided by AssertJ, you can register your callback with setAfterAssertionErrorCollected(AfterAssertionErrorCollected) or addAfterAssertionErrorCollected(AfterAssertionErrorCollected) if you have many.

      Example with custom soft assertions: 

       class TolkienSoftAssertions extends SoftAssertions {

   public TolkienHeroesAssert assertThat(TolkienHero actual) {
     return proxy(TolkienHeroesAssert.class, TolkienHero.class, actual);
   }

   @Override
   public void onAssertionErrorCollected(AssertionError assertionError) {
     System.out.println(assertionError);
   }
 }

 TolkienSoftAssertions softly = new TolkienSoftAssertions();

 TolkienCharacter frodo = TolkienCharacter.of("Frodo", 33, HOBBIT);

 // the AssertionError corresponding to this failing assertion is printed to the console.
 softly.assertThat(frodo).hasName("Bilbo");

      Example with standard soft assertions: 

       SoftAssertions softly = new SoftAssertions();

 // register our callback
 softly.addAfterAssertionErrorCollected(error -> System.out.println(error));

 // the AssertionError corresponding to this failing assertion is printed to the console.
 softly.assertThat("The Beatles").isEqualTo("The Rolling Stones");
      Specified by:
      onAssertionErrorCollected in interface AfterAssertionErrorCollected
      Parameters:
      assertionError - the collected AssertionError.

    • succeeded

      void succeeded()
      Indicates/sets that the last assertion was a success.

    • wasSuccess

      boolean wasSuccess()
      Returns the result of last soft assertion which can be used to decide what the next one should be.

      Example: 

       Person person = ...
 SoftAssertions soft = new SoftAssertions();
 if (soft.assertThat(person.getAddress()).isNotNull().wasSuccess()) {
     soft.assertThat(person.getAddress().getStreet()).isNotNull();
 }
      Returns:
      true if the last assertion was a success.