Class AssertionFailedError

  • All Implemented Interfaces:
    java.io.Serializable

    public class AssertionFailedError
    extends java.lang.AssertionError
    AssertionFailedError is a common base class for test-related AssertionErrors.

    In addition to a message and a cause, this class stores the expected and actual values of an assertion using the ValueWrapper type.

    Since:
    1.0
    Author:
    Sam Brannen, Marc Philipp
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      AssertionFailedError()
      Constructs an AssertionFailedError with an empty message, no cause, and no expected/actual values.
      AssertionFailedError​(java.lang.String message)
      Constructs an AssertionFailedError with a message, no cause, and no expected/actual values.
      AssertionFailedError​(java.lang.String message, java.lang.Object expected, java.lang.Object actual)
      Constructs an AssertionFailedError with a message and expected/actual values but without a cause.
      AssertionFailedError​(java.lang.String message, java.lang.Object expected, java.lang.Object actual, java.lang.Throwable cause)
      Constructs an AssertionFailedError with a message, expected/actual values, and a cause.
      AssertionFailedError​(java.lang.String message, java.lang.Throwable cause)
      Constructs an AssertionFailedError with a message and a cause but without expected/actual values.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ValueWrapper getActual()
      Returns the wrapped actual value if it is defined; otherwise null.
      ValueWrapper getExpected()
      Returns the wrapped expected value if it is defined; otherwise null.
      boolean isActualDefined()
      Returns true if an actual value was supplied via an appropriate constructor.
      boolean isExpectedDefined()
      Returns true if an expected value was supplied via an appropriate constructor.
      java.lang.String toString()
      Returns a short description of this assertion error using the same format as Throwable.toString().
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AssertionFailedError

        public AssertionFailedError()
        Constructs an AssertionFailedError with an empty message, no cause, and no expected/actual values.
      • AssertionFailedError

        public AssertionFailedError​(java.lang.String message)
        Constructs an AssertionFailedError with a message, no cause, and no expected/actual values.
        Parameters:
        message - the detail message; null or blank will be converted to the empty String
      • AssertionFailedError

        public AssertionFailedError​(java.lang.String message,
                                    java.lang.Object expected,
                                    java.lang.Object actual)
        Constructs an AssertionFailedError with a message and expected/actual values but without a cause.
        Parameters:
        message - the detail message; null or blank will be converted to the empty String
        expected - the expected value; may be null
        actual - the actual value; may be null
      • AssertionFailedError

        public AssertionFailedError​(java.lang.String message,
                                    java.lang.Throwable cause)
        Constructs an AssertionFailedError with a message and a cause but without expected/actual values.
        Parameters:
        message - the detail message; null or blank will be converted to the empty String
        cause - the cause of the failure
      • AssertionFailedError

        public AssertionFailedError​(java.lang.String message,
                                    java.lang.Object expected,
                                    java.lang.Object actual,
                                    java.lang.Throwable cause)
        Constructs an AssertionFailedError with a message, expected/actual values, and a cause.
        Parameters:
        message - the detail message; null or blank will be converted to the empty String
        expected - the expected value; may be null
        actual - the actual value; may be null
        cause - the cause of the failure
    • Method Detail

      • isExpectedDefined

        public boolean isExpectedDefined()
        Returns true if an expected value was supplied via an appropriate constructor.
        See Also:
        getExpected()
      • isActualDefined

        public boolean isActualDefined()
        Returns true if an actual value was supplied via an appropriate constructor.
        See Also:
        getActual()
      • toString

        public java.lang.String toString()
        Returns a short description of this assertion error using the same format as Throwable.toString().

        Since the constructors of this class convert supplied null or blank messages to the empty String, this method only includes non-empty messages in its return value.

        Overrides:
        toString in class java.lang.Throwable
        Returns:
        a string representation of this AssertionFailedError
        Since:
        1.1.1