de.larssh.utils.test

Class AssertEqualsAndHashCodeArguments

java.lang.Object

de.larssh.utils.test.AssertEqualsAndHashCodeArguments

public class AssertEqualsAndHashCodeArguments
extends Object

Value object containing arguments in an original and a changed form, to be used for asserting the methods Object.equals(Object) and Object.hashCode().

The following example is made for a class called Person. That class contains three fields (see below) and a constructor accordingly.

1. Personal ID (used for equality)
2. First name (not used for equality)
3. Last name (not used for equality)

 assertEqualsAndHashCode(a -> new Person((int) a[0], (String) a[0], (String) a[0]),
     new AssertEqualsAndHashCodeArguments()
         .add(123, 456, true)
         .add('John', 'Jane', false)
         .add('Doe', 'Smith', false));
 

Constructor Summary

Constructors

Constructor and Description
AssertEqualsAndHashCodeArguments()

Method Summary

Modifier and Type	Method and Description
AssertEqualsAndHashCodeArguments	add(Object original, Object changed, boolean expectEquality) Adds information of one more argument to the current list of arguments.
protected List<Object>	getChanged() List of changed arguments
List<Object>	getChangedArguments(int... indexToBeChanged) Returns a list of original arguments, which is changed at the given indexes.
List<Object>	getOriginal() List of original arguments
boolean	isExpectEquality(int index) Returns true, if the argument at index is meant to be used for equality checks.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssertEqualsAndHashCodeArguments

public AssertEqualsAndHashCodeArguments()

Method Detail

add

public AssertEqualsAndHashCodeArguments add(@Nullable
                                            Object original,
                                            @Nullable
                                            Object changed,
                                            boolean expectEquality)

Adds information of one more argument to the current list of arguments.

Parameters:

original - original value

changed - changed value

expectEquality - true, if argument is used for equality

Returns:

this

getOriginal

public List<Object> getOriginal()

List of original arguments

Returns:

list of original arguments

getChanged

protected List<Object> getChanged()

List of changed arguments

Returns:

list of changed arguments

getChangedArguments

public List<Object> getChangedArguments(int... indexToBeChanged)

Returns a list of original arguments, which is changed at the given indexes.

Parameters:

indexToBeChanged - list of indexes to be changed

Returns:

list of arguments, changed at indexToBeChanged

isExpectEquality

public boolean isExpectEquality(int index)

Returns true, if the argument at index is meant to be used for equality checks.

Parameters:

index - argument index

Returns:

true, if index is used for equality