Deprecate hasCauseReference(throwable) in favor of cause().isSameAs(throwable)

joel-costigliola · joel-costigliola · commit d692186de687 · 2024-12-29T19:00:48.000+01:00
Fix #3715
diff --git a/assertj-core/src/main/java/org/assertj/core/api/AbstractThrowableAssert.java b/assertj-core/src/main/java/org/assertj/core/api/AbstractThrowableAssert.java
@@ -133,6 +133,8 @@ public SELF hasCause(Throwable cause) {
    *
    * // This assertion succeeds:
    * assertThat(throwable).hasCauseReference(invalidArgException);
+   * // same assertion but more idiomatic in future versions
+   * assertThat(throwable).cause().isSameAs(invalidArgException);
    *
    * // These assertions fail:
    * assertThat(throwable).hasCauseReference(new IllegalArgumentException("invalid arg"));
@@ -143,9 +145,12 @@ public SELF hasCause(Throwable cause) {
    * @return this assertion object.
    * @throws AssertionError if the actual {@code Throwable} is {@code null}.
    * @throws AssertionError if the actual {@code Throwable} has a cause that does not refer to the given (i.e. actual.getCause() != cause)
+   * @deprecated use <code class='java'> cause().isSameAs(expected)</code> instead.
    *
    * @since 3.13.0
+   * @see  #cause()
    */
+  @Deprecated
   public SELF hasCauseReference(Throwable expected) {
     throwables.assertHasCauseReference(info, actual, expected);
     return myself;
