Package org.assertj.core.error

Class ShouldBeEqual

java.lang.Object

org.assertj.core.error.ShouldBeEqual

All Implemented Interfaces:

AssertionErrorFactory

public class ShouldBeEqual
extends Object
implements AssertionErrorFactory

Creates an AssertionError indicating that an assertion that verifies that two objects are equal failed.

The built AssertionError's message differentiates actual and expected description if their string representation are the same (e.g. 42 float and 42 double). It also mentions the comparator in case of a custom comparator is used (instead of equals method).

Author:

Alex Ruiz, Yvonne Wang, Joel Costigliola

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	actual
private ComparisonStrategy	comparisonStrategy
(package private) ConstructorInvoker	constructorInvoker
(package private) DescriptionFormatter	descriptionFormatter
protected Object	expected
private static String	EXPECTED_BUT_WAS_MESSAGE
private static String	EXPECTED_BUT_WAS_MESSAGE_USING_COMPARATOR
(package private) MessageFormatter	messageFormatter
private static Class<?>[]	MSG_ARG_TYPES
private static Class<?>[]	MSG_ARG_TYPES_FOR_ASSERTION_FAILED_ERROR
private Representation	representation

Constructor Summary

Constructors

Constructor	Description
ShouldBeEqual(Object actual, Object expected, ComparisonStrategy comparisonStrategy, Representation representation)

Method Summary

Modifier and Type	Method	Description
private boolean	actualAndExpectedHaveSameStringRepresentation()
private AssertionError	assertionFailedError(String message)
private AssertionError	comparisonFailure(Description description)
private String	defaultDetailedErrorMessage(Description description, Representation representation)	Builds and returns an error message from description using detailedExpected() and detailedActual() detailed representation.
private String	detailedActual()
private String	detailedExpected()
boolean	equals(Object o)
int	hashCode()
private Object[]	msgArgs(String description)
AssertionError	newAssertionError(Description description, Representation representation)	Creates an AssertionError indicating that an assertion that verifies that two objects are equal failed. The AssertionError message is built so that it differentiates actual and expected description in case their string representation are the same (like 42 float and 42 double).
private AssertionError	newComparisonFailure(String description)
static AssertionErrorFactory	shouldBeEqual(Object actual, Object expected, ComparisonStrategy comparisonStrategy, Representation representation)	Creates a new ShouldBeEqual.
static AssertionErrorFactory	shouldBeEqual(Object actual, Object expected, Representation representation)	Creates a new ShouldBeEqual.
private String	smartErrorMessage(Description description, Representation representation)	Builds and returns an error message from the given description using expected and actual basic representation if their description differ otherwise use defaultDetailedErrorMessage(Description, Representation) to represent them differently.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXPECTED_BUT_WAS_MESSAGE

private static final String EXPECTED_BUT_WAS_MESSAGE

See Also:

Constant Field Values

EXPECTED_BUT_WAS_MESSAGE_USING_COMPARATOR

private static final String EXPECTED_BUT_WAS_MESSAGE_USING_COMPARATOR

See Also:

Constant Field Values

MSG_ARG_TYPES

private static final Class<?>[] MSG_ARG_TYPES

MSG_ARG_TYPES_FOR_ASSERTION_FAILED_ERROR

private static final Class<?>[] MSG_ARG_TYPES_FOR_ASSERTION_FAILED_ERROR

actual

protected final Object actual

expected

protected final Object expected

messageFormatter

final MessageFormatter messageFormatter

comparisonStrategy

private final ComparisonStrategy comparisonStrategy

representation

private Representation representation

constructorInvoker

ConstructorInvoker constructorInvoker

descriptionFormatter

DescriptionFormatter descriptionFormatter

Constructor Detail

ShouldBeEqual

ShouldBeEqual(Object actual,
              Object expected,
              ComparisonStrategy comparisonStrategy,
              Representation representation)

Method Detail

shouldBeEqual

public static AssertionErrorFactory shouldBeEqual(Object actual,
                                                  Object expected,
                                                  Representation representation)

Creates a new ShouldBeEqual.

Parameters:

actual - the actual value in the failed assertion.

expected - the expected value in the failed assertion.

representation - the Representation used to format values.

Returns:

the created AssertionErrorFactory.

shouldBeEqual

public static AssertionErrorFactory shouldBeEqual(Object actual,
                                                  Object expected,
                                                  ComparisonStrategy comparisonStrategy,
                                                  Representation representation)

Creates a new ShouldBeEqual.

Parameters:

actual - the actual value in the failed assertion.

expected - the expected value in the failed assertion.

comparisonStrategy - the ComparisonStrategy used to compare actual with expected.

representation - the Representation used to format values.

Returns:

the created AssertionErrorFactory.

newAssertionError

public AssertionError newAssertionError(Description description,
                                        Representation representation)

Creates an AssertionError indicating that an assertion that verifies that two objects are equal failed.
The AssertionError message is built so that it differentiates actual and expected description in case their string representation are the same (like 42 float and 42 double).

If JUnit 4 is in the classpath and the description is standard (no comparator was used and actual and expected string representation were different), this method will instead create a org.junit.ComparisonFailure that highlights the difference(s) between the expected and actual objects.

If opentest4j is on the classpath then org.opentest4j.AssertionFailedError would be used.

AssertionError stack trace won't show AssertJ related elements if Failures is configured to filter them (see Failures.setRemoveAssertJRelatedElementsFromStackTrace(boolean)).

Specified by:

newAssertionError in interface AssertionErrorFactory

Parameters:

description - the description of the failed assertion.

representation - the Representation used to format values.

Returns:

the created AssertionError.

actualAndExpectedHaveSameStringRepresentation

private boolean actualAndExpectedHaveSameStringRepresentation()

smartErrorMessage

private String smartErrorMessage(Description description,
                                 Representation representation)

Builds and returns an error message from the given description using expected and actual basic representation if their description differ otherwise use defaultDetailedErrorMessage(Description, Representation) to represent them differently.

Parameters:

description - the Description used to build the returned error message

representation - the Representation used to build String representation of object

Returns:

the error message from description using expected and actual "smart" representation.

defaultDetailedErrorMessage

private String defaultDetailedErrorMessage(Description description,
                                           Representation representation)

Builds and returns an error message from description using detailedExpected() and detailedActual() detailed representation.

Parameters:

description - the Description used to build the returned error message

representation - the Representation used to build String representation of object

Returns:

the error message from description using detailedExpected() and detailedActual() detailed representation.

assertionFailedError

private AssertionError assertionFailedError(String message)

comparisonFailure

private AssertionError comparisonFailure(Description description)

newComparisonFailure

private AssertionError newComparisonFailure(String description)
                                     throws Exception

Throws:

Exception

msgArgs

private Object[] msgArgs(String description)

detailedActual

private String detailedActual()

detailedExpected

private String detailedExpected()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object