org.opentest4j

Class AssertionFailedError

java.lang.Object

java.lang.Throwable

java.lang.Error

java.lang.AssertionError

org.opentest4j.AssertionFailedError

All Implemented Interfaces:

Serializable

public class AssertionFailedError
extends 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 and Description
AssertionFailedError() Constructs an AssertionFailedError with no message, no cause, and no expected/actual values.
AssertionFailedError(String message) Constructs an AssertionFailedError with a message, no cause, and no expected/actual values.
AssertionFailedError(String message, Object expected, Object actual) Constructs an AssertionFailedError with a message and expected/actual values but without a cause.
AssertionFailedError(String message, Object expected, Object actual, Throwable cause) Constructs an AssertionFailedError with a message, expected/actual values, and a cause.
AssertionFailedError(String message, Throwable cause) Constructs an AssertionFailedError with a message and a cause but without expected/actual values.

Method Summary

Modifier and Type	Method and 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.
String	getMessage() Returns the error message, potentially null.
boolean	isActualDefined() Returns true if the actual value is defined, i.e.
boolean	isExpectedDefined() Returns true if the expected value is defined, i.e.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

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 no message, no cause, and no expected/actual values.

AssertionFailedError

public AssertionFailedError(String message)

Constructs an AssertionFailedError with a message, no cause, and no expected/actual values.

AssertionFailedError

public AssertionFailedError(String message,
                            Object expected,
                            Object actual)

Constructs an AssertionFailedError with a message and expected/actual values but without a cause.

AssertionFailedError

public AssertionFailedError(String message,
                            Throwable cause)

Constructs an AssertionFailedError with a message and a cause but without expected/actual values.

AssertionFailedError

public AssertionFailedError(String message,
                            Object expected,
                            Object actual,
                            Throwable cause)

Constructs an AssertionFailedError with a message, expected/actual values, and a cause.

Method Detail

getMessage

public String getMessage()

Returns the error message, potentially null.

Overrides:

getMessage in class Throwable

See Also:

Throwable.getMessage()

isExpectedDefined

public boolean isExpectedDefined()

Returns true if the expected value is defined, i.e. was passed to the constructor.

See Also:

getExpected()

isActualDefined

public boolean isActualDefined()

Returns true if the actual value is defined, i.e. was passed to the constructor.

See Also:

getActual()

getExpected

public ValueWrapper getExpected()

Returns the wrapped expected value if it is defined; otherwise null.

See Also:

isExpectedDefined()

getActual

public ValueWrapper getActual()

Returns the wrapped actual value if it is defined; otherwise null.

See Also:

isActualDefined()