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 an empty 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.
boolean	isActualDefined() Returns true if the actual value is defined, i.e.
boolean	isExpectedDefined() Returns true if the expected value is defined, i.e.
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(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 because the AssertionError superclass does not support null messages.

AssertionFailedError

public AssertionFailedError(String message,
                            Object expected,
                            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 because the AssertionError superclass does not support null messages.

AssertionFailedError

public AssertionFailedError(String message,
                            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 because the AssertionError superclass does not support null messages.

AssertionFailedError

public AssertionFailedError(String message,
                            Object expected,
                            Object actual,
                            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 because the AssertionError superclass does not support null messages.

Method Detail

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()

toString

public String toString()

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

Overrides:

toString in class Throwable

Returns:

Since the AssertionError superclass does not support null messages and 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.