public Class DefaultAssertionErrorCollector

Register a callback allowing to react after an AssertionError is collected by the current soft assertions.

The callback is an instance of AfterAssertionErrorCollected which can be expressed as a lambda.

Example:

 SoftAssertions softly = new SoftAssertions();
StringBuilder reportBuilder = new StringBuilder(String.format("Assertion errors report:%n"));

// register a single callback with:
softly.setAfterAssertionErrorCollected(error -> reportBuilder.append(String.format("------------------%n%s%n", error.getMessage())));
// or as many as needed with:
// softly.addAfterAssertionErrorCollected(error -> reportBuilder.append(String.format("------------------%n%s%n", error.getMessage())));

// the AssertionErrors corresponding to the failing assertions are registered in the report
softly.assertThat("The Beatles").isEqualTo("The Rolling Stones");
softly.assertThat(123).isEqualTo(123)
                      .isEqualTo(456);

Resulting reportBuilder:

 Assertion errors report:
------------------
Expecting:
 <"The Beatles">
to be equal to:
 <"The Rolling Stones">
but was not.
------------------
Expecting:
 <123>
to be equal to:
 <456>
but was not.

Alternatively, if you have defined your own SoftAssertions subclass and inherited from AbstractSoftAssertions, the only thing you have to do is to override AfterAssertionErrorCollected#onAssertionErrorCollected(AssertionError).

Parameters

afterAssertionErrorCollected:AfterAssertionErrorCollected

the callback.

Since

3.26.0

Implements org.assertj.core.api.AssertionErrorCollector.assertionErrorsCollected.

Returns a list of soft assertions collected errors. If a delegate has been set (see setDelegate(), then this method will return the result of the delegate's assertErrorsCollected().

Returns:List<AssertionError>

A list of soft assertions collected errors.

Annotations

@Override

Implements org.assertj.core.api.AssertionErrorCollector.collectAssertionError.

Doc from org.assertj.core.api.AssertionErrorCollector.collectAssertionError.

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:AssertionError

the AssertionError to collect.

Annotations

@Override

Overrides default org.assertj.core.api.AssertionErrorCollector.getDelegate.

Annotations

@Override

Same as DefaultAssertionErrorCollector#addAfterAssertionErrorCollected(AfterAssertionErrorCollected), but also removes all previously added callbacks.

Parameters

afterAssertionErrorCollected:AfterAssertionErrorCollected

the callback.

Since

3.17.0

Overrides default org.assertj.core.api.AssertionErrorCollector.setDelegate.

Doc from org.assertj.core.api.AssertionErrorCollector.setDelegate.

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:AssertionErrorCollector

the AssertionErrorCollector to which the assertions will be forwarded.

Annotations

@Override

Implements org.assertj.core.api.AssertionErrorCollector.succeeded.

Doc from org.assertj.core.api.AssertionErrorCollector.succeeded.

Indicates/sets that the last assertion was a success.

Annotations

@Override

Implements org.assertj.core.api.AssertionErrorCollector.wasSuccess.

Doc from org.assertj.core.api.AssertionErrorCollector.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:boolean

true if the last assertion was a success.

Annotations

@Override