Class EqualsAssertionException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
cloud.opencode.base.core.exception.OpenException
cloud.opencode.base.test.exception.TestException
cloud.opencode.base.test.exception.AssertionException
cloud.opencode.base.test.exception.EqualsAssertionException
All Implemented Interfaces:
Serializable
public class EqualsAssertionException extends AssertionException
Equals Assertion Exception - Exception for equality assertion failures 相等断言异常 - 相等断言失败时抛出的异常

This specialized exception is thrown when an equality assertion fails, providing detailed information about expected and actual values.

此专门异常在相等断言失败时抛出，提供期望值和实际值的详细信息。

Features | 主要功能:

  • Expected/actual value tracking - 期望值/实际值跟踪
  • Detailed comparison info with type and diff index - 带类型和差异索引的详细比较信息
  • Factory methods and assertion helpers - 工厂方法和断言辅助

Usage Examples | 使用示例:

// Basic usage
throw EqualsAssertionException.of("expected", "actual");

// With custom message
throw EqualsAssertionException.of("expected", "actual", "Values should match");

// Check values and throw if not equal
EqualsAssertionException.assertEqualsOrThrow(expected, actual);

Security | 安全性:

  • Thread-safe: Yes (immutable after construction) - 线程安全: 是（构造后不可变）
  • Null-safe: Yes (handles null expected/actual values) - 空值安全: 是（处理空的期望值/实际值）
Since:
JDK 25, opencode-base-test V1.0.0
Author:
Leon Soo www.LeonSoo.com
See Also:

  • Constructor Details

    • EqualsAssertionException

      public EqualsAssertionException(Object expected, Object actual)
      Creates equals assertion exception with expected and actual values. 使用期望值和实际值创建相等断言异常。
      Parameters:
      expected - the expected value | 期望值
      actual - the actual value | 实际值

    • EqualsAssertionException

      public EqualsAssertionException(Object expected, Object actual, String message)
      Creates equals assertion exception with expected, actual values and message. 使用期望值、实际值和消息创建相等断言异常。
      Parameters:
      expected - the expected value | 期望值
      actual - the actual value | 实际值
      message - additional message | 附加消息

    • EqualsAssertionException

      public EqualsAssertionException(String message)
      Creates equals assertion exception with message only. 仅使用消息创建相等断言异常。
      Parameters:
      message - the message | 消息

    • EqualsAssertionException

      public EqualsAssertionException(String message, Throwable cause)
      Creates equals assertion exception with message and cause. 使用消息和原因创建相等断言异常。
      Parameters:
      message - the message | 消息
      cause - the cause | 原因

  • Method Details

    • of

      public static EqualsAssertionException of(Object expected, Object actual)
      Creates exception for mismatched values. 为不匹配的值创建异常。
      Parameters:
      expected - the expected value | 期望值
      actual - the actual value | 实际值
      Returns:
      the exception | 异常

    • of

      public static EqualsAssertionException of(Object expected, Object actual, String message)
      Creates exception for mismatched values with message. 为不匹配的值创建异常（带消息）。
      Parameters:
      expected - the expected value | 期望值
      actual - the actual value | 实际值
      message - additional message | 附加消息
      Returns:
      the exception | 异常

    • expectedNull

      public static EqualsAssertionException expectedNull(Object actual)
      Creates exception for null expected value. 为空期望值创建异常。
      Parameters:
      actual - the actual value | 实际值
      Returns:
      the exception | 异常

    • actualNull

      public static EqualsAssertionException actualNull(Object expected)
      Creates exception for null actual value. 为空实际值创建异常。
      Parameters:
      expected - the expected value | 期望值
      Returns:
      the exception | 异常

    • assertEqualsOrThrow

      public static void assertEqualsOrThrow(Object expected, Object actual)
      Assert equality and throw if not equal. 断言相等，如果不相等则抛出异常。
      Parameters:
      expected - the expected value | 期望值
      actual - the actual value | 实际值
      Throws:
      EqualsAssertionException - if not equal | 如果不相等

    • assertEqualsOrThrow

      public static void assertEqualsOrThrow(Object expected, Object actual, String message)
      Assert equality and throw if not equal, with message. 断言相等，如果不相等则抛出异常（带消息）。
      Parameters:
      expected - the expected value | 期望值
      actual - the actual value | 实际值
      message - the message | 消息
      Throws:
      EqualsAssertionException - if not equal | 如果不相等

    • getExpected

      public Object getExpected()
      Get the expected value. 获取期望值。
      Returns:
      the expected value | 期望值

    • getActual

      public Object getActual()
      Get the actual value. 获取实际值。
      Returns:
      the actual value | 实际值

    • getExpectedString

      public String getExpectedString()
      Get the expected value as string. 获取期望值的字符串表示。
      Returns:
      expected as string | 期望值字符串

    • getActualString

      public String getActualString()
      Get the actual value as string. 获取实际值的字符串表示。
      Returns:
      actual as string | 实际值字符串

    • getComparisonInfo

      public String getComparisonInfo()
      Get detailed comparison info. 获取详细比较信息。
      Returns:
      comparison info | 比较信息