AssertJ Core 3.26.0 · org.assertj.core.api.AbstractSoftAssertions

Modifier and Type	Field and Description
private static final AssertionErrorCreator	ASSERTION_ERROR_CREATOR
pack-priv final SoftProxies	proxies

Access	Constructor and Description
protected	AbstractSoftAssertions()

Method Summary

Modifier and Type	Method and Description
public static void	assertAll(AssertionErrorCollector collector)
public void	assertAll() Implements org.assertj.core.api.SoftAssertionsProvider.assertAll. Verifies that no soft assertions have failed.
public List<Throwable>	Returns: a copy of list of soft assertions collected errors. errorsCollected() Returns a copy of list of soft assertions collected errors.
public < dummy return value type T> T	Returns: nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail("boom")));`. fail(String error message. failureMessage) Fails with the given message.
public < dummy return value type T> T	Returns: nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail()));`. fail() Fails with an empty message to be used in code like: `doSomething(optional.orElseGet(() -> softly.fail()));`
public < dummy return value type T> T	Returns: nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail("boom")));`. fail(String error message. failureMessage, Object... Arguments referenced by the format specifiers in the format string. args) Fails with the given message built like `String#format(String, Object...)`.
public < dummy return value type T> T	Returns: nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail("boom")));`. fail(String error message. failureMessage, Throwable cause of the error. realCause) Fails with the given message and with the `Throwable` that caused the failure.
public < dummy return value type T> T	Returns: nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail(cause)));`. fail(Throwable cause of the error. realCause) Fails with the `Throwable` that caused the failure and an empty message.
public void	failBecauseExceptionWasNotThrown(Class<? extends Throwable> the Throwable class that was expected to be thrown. throwableClass) Fails with a message explaining that a `Throwable` of given class was expected to be thrown but had not been.
public <SELF extends Assert<? extends SELF, ? extends ACTUAL>, ACTUAL> SELF	proxy(Class<SELF> Class instance for the assertion type. assertClass, Class<ACTUAL> Class instance for the type of the object-under-test. actualClass, ACTUAL The actual object-under-test. actual) Implements org.assertj.core.api.SoftAssertionsProvider.proxy. Creates a proxied assertion class of the given type.
public void	shouldHaveThrown(Class<? extends Throwable> the Throwable class that was expected to be thrown. throwableClass) Fails with a message explaining that a `Throwable` of given class was expected to be thrown but had not been.

Inherited from org.assertj.core.api.DefaultAssertionErrorCollector:: addAfterAssertionErrorCollected assertionErrorsCollected collectAssertionError decorateErrorsCollected getDelegate setAfterAssertionErrorCollected setDelegate succeeded wasSuccess

ASSERTION_ERROR_CREATOR	back to summary
private static final AssertionErrorCreator ASSERTION_ERROR_CREATOR

proxies	back to summary
pack-priv final SoftProxies proxies

AbstractSoftAssertions	back to summary
protected AbstractSoftAssertions()

Method Detail

assertAll	back to summary
public static void assertAll(AssertionErrorCollector collector)

assertAll	back to summary
public void assertAll() Implements org.assertj.core.api.SoftAssertionsProvider.assertAll. Doc from org.assertj.core.api.SoftAssertionsProvider.assertAll. Verifies that no soft assertions have failed. Annotations @Override

assertAll

back to summary

public void assertAll()

Implements org.assertj.core.api.SoftAssertionsProvider.assertAll.

Doc from org.assertj.core.api.SoftAssertionsProvider.assertAll.

Verifies that no soft assertions have failed.

Annotations

@Override

errorsCollected	back to summary
public List<Throwable> errorsCollected() Returns a copy of list of soft assertions collected errors. Returns:List<Throwable> a copy of list of soft assertions collected errors.

errorsCollected

back to summary

public List<Throwable> errorsCollected()

Returns a copy of list of soft assertions collected errors.

Returns:List<Throwable>: a copy of list of soft assertions collected errors.

fail back to summary

fail	back to summary
public <T> T fail(String failureMessage) Fails with the given message. Parameters <T> dummy return value type failureMessage:String error message. Returns:T nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail("boom")));`. Annotations @CanIgnoreReturnValue Since 2.6.0 / 3.6.0

public <T> T fail(String failureMessage)

Fails with the given message.

Parameters

<T>: dummy return value type
failureMessage:String: error message.

Returns:T

nothing, it's just to be used in doSomething(optional.orElseGet(() -> softly.fail("boom")));.

Annotations

@CanIgnoreReturnValue

Since

2.6.0 / 3.6.0

fail back to summary

fail	back to summary
public <T> T fail() Fails with an empty message to be used in code like: `doSomething(optional.orElseGet(() -> softly.fail()));` Parameters <T> dummy return value type Returns:T nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail()));`. Annotations @CanIgnoreReturnValue Since 3.26.0

public <T> T fail()

Fails with an empty message to be used in code like:

 doSomething(optional.orElseGet(() -> softly.fail()));

Parameters

<T>: dummy return value type

Returns:T

nothing, it's just to be used in doSomething(optional.orElseGet(() -> softly.fail()));.

Annotations

@CanIgnoreReturnValue

Since

3.26.0

fail back to summary

fail	back to summary
public <T> T fail(String failureMessage, Object... args) Fails with the given message built like `String#format(String, Object...)`. Parameters <T> dummy return value type failureMessage:String error message. args:Object[] Arguments referenced by the format specifiers in the format string. Returns:T nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail("boom")));`. Annotations @CanIgnoreReturnValue Since 2.6.0 / 3.6.0

public <T> T fail(String failureMessage, Object... args)

Fails with the given message built like String#format(String, Object...).

Parameters

<T>: dummy return value type
failureMessage:String: error message.
args:Object[]: Arguments referenced by the format specifiers in the format string.

Returns:T

nothing, it's just to be used in doSomething(optional.orElseGet(() -> softly.fail("boom")));.

Annotations

@CanIgnoreReturnValue

Since

2.6.0 / 3.6.0

fail back to summary

fail	back to summary
public <T> T fail(String failureMessage, Throwable realCause) Fails with the given message and with the `Throwable` that caused the failure. Parameters <T> dummy return value type failureMessage:String error message. realCause:Throwable cause of the error. Returns:T nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail("boom")));`. Annotations @CanIgnoreReturnValue Since 2.6.0 / 3.6.0

public <T> T fail(String failureMessage, Throwable realCause)

Fails with the given message and with the Throwable that caused the failure.

Parameters

<T>: dummy return value type
failureMessage:String: error message.
realCause:Throwable: cause of the error.

Returns:T

nothing, it's just to be used in doSomething(optional.orElseGet(() -> softly.fail("boom")));.

Annotations

@CanIgnoreReturnValue

Since

2.6.0 / 3.6.0

fail back to summary

fail	back to summary
public <T> T fail(Throwable realCause) Fails with the `Throwable` that caused the failure and an empty message. Example: `doSomething(optional.orElseGet(() -> softly.fail(cause)));` Parameters <T> dummy return value type realCause:Throwable cause of the error. Returns:T nothing, it's just to be used in `doSomething(optional.orElseGet(() -> softly.fail(cause)));`. Annotations @CanIgnoreReturnValue Since 3.26.0

public <T> T fail(Throwable realCause)

Fails with the Throwable that caused the failure and an empty message.

Example:

 doSomething(optional.orElseGet(() -> softly.fail(cause)));

Parameters

<T>: dummy return value type
realCause:Throwable: cause of the error.

Returns:T

nothing, it's just to be used in doSomething(optional.orElseGet(() -> softly.fail(cause)));.

Annotations

@CanIgnoreReturnValue

Since

3.26.0

failBecauseExceptionWasNotThrown back to summary

failBecauseExceptionWasNotThrown	back to summary
public void failBecauseExceptionWasNotThrown(Class<? extends Throwable> throwableClass) Fails with a message explaining that a `Throwable` of given class was expected to be thrown but had not been. Parameters throwableClass:Class<? extends Throwable> the Throwable class that was expected to be thrown. Exceptions AssertionError: with a message explaining that a `Throwable` of given class was expected to be thrown but had not been. Since 2.6.0 / 3.6.0 `Fail#shouldHaveThrown(Class)` can be used as a replacement.

public void failBecauseExceptionWasNotThrown(Class<? extends Throwable> throwableClass)

Fails with a message explaining that a Throwable of given class was expected to be thrown but had not been.

Parameters

throwableClass:Class<? extends Throwable>: the Throwable class that was expected to be thrown.

Exceptions

AssertionError:: with a message explaining that a Throwable of given class was expected to be thrown but had not been.

Since

2.6.0 / 3.6.0 Fail#shouldHaveThrown(Class) can be used as a replacement.

proxy	back to summary
public <SELF extends Assert<? extends SELF, ? extends ACTUAL>, ACTUAL> SELF proxy(Class<SELF> assertClass, Class<ACTUAL> actualClass, ACTUAL actual) Implements org.assertj.core.api.SoftAssertionsProvider.proxy. Doc from org.assertj.core.api.SoftAssertionsProvider.proxy. Creates a proxied assertion class of the given type. The returned value is an assertion object compatible with the supplied assertion class, but instead of throwing errors it will collect them and store. Parameters <SELF> The type of the assertion class <ACTUAL> The type of the object-under-test assertClass:Class<SELF> Class instance for the assertion type. actualClass:Class<ACTUAL> Class instance for the type of the object-under-test. actual:ACTUAL The actual object-under-test. Returns:SELF A proxied assertion class for the given object-under-test. Annotations @Override

proxy

back to summary

public <SELF extends Assert<? extends SELF, ? extends ACTUAL>, ACTUAL> SELF proxy(Class<SELF> assertClass, Class<ACTUAL> actualClass, ACTUAL actual)

Implements org.assertj.core.api.SoftAssertionsProvider.proxy.

Doc from org.assertj.core.api.SoftAssertionsProvider.proxy.

Creates a proxied assertion class of the given type. The returned value is an assertion object compatible with the supplied assertion class, but instead of throwing errors it will collect them and store.

Parameters

<SELF>: The type of the assertion class
<ACTUAL>: The type of the object-under-test
assertClass:Class<SELF>: Class instance for the assertion type.
actualClass:Class<ACTUAL>: Class instance for the type of the object-under-test.
actual:ACTUAL: The actual object-under-test.

Returns:SELF

A proxied assertion class for the given object-under-test.

Annotations

@Override

shouldHaveThrown back to summary

shouldHaveThrown	back to summary
public void shouldHaveThrown(Class<? extends Throwable> throwableClass) Fails with a message explaining that a `Throwable` of given class was expected to be thrown but had not been. Parameters throwableClass:Class<? extends Throwable> the Throwable class that was expected to be thrown. Exceptions AssertionError: with a message explaining that a `Throwable` of given class was expected to be thrown but had not been. Since 2.6.0 / 3.6.0

public void shouldHaveThrown(Class<? extends Throwable> throwableClass)

Fails with a message explaining that a Throwable of given class was expected to be thrown but had not been.

Parameters

throwableClass:Class<? extends Throwable>: the Throwable class that was expected to be thrown.

Exceptions

AssertionError:: with a message explaining that a Throwable of given class was expected to be thrown but had not been.

Since

2.6.0 / 3.6.0

public abstract Class AbstractSoftAssertions

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail