net.trajano.commons.testing

Class EqualsTestUtil

java.lang.Object

net.trajano.commons.testing.EqualsTestUtil

public final class EqualsTestUtil
extends Object

This provides utility methods that ensure the Object.equals(Object) and Object.hashCode() are implemented correctly.

Author:

Archimedes Trajano

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EqualsTestUtil() Prevent instantiation of utility class.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> void	assertEqualsImplementedCorrectly(Callable<T> objectBuilder) Builds two objects the same way and checks if they are equal.
static <T> void	assertEqualsImplementedCorrectly(Callable<T> objectBuilder1, Callable<T> objectBuilder2) Builds two objects and ensures that they are equal.
static void	assertEqualsImplementedCorrectly(Object o1, Object o2) Take two objects and ensure their are implemented correctly.
static <T> void	assertEqualsImplementedCorrectly(T o) Take a single object and ensure its equality is implemented correctly.

Methods inherited from class java.lang.Object

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

Constructor Detail

EqualsTestUtil

private EqualsTestUtil()

Prevent instantiation of utility class.

Method Detail

assertEqualsImplementedCorrectly

public static <T> void assertEqualsImplementedCorrectly(Callable<T> objectBuilder)

Builds two objects the same way and checks if they are equal.

Type Parameters:

T - type

Parameters:

objectBuilder - object builder

assertEqualsImplementedCorrectly

public static <T> void assertEqualsImplementedCorrectly(Callable<T> objectBuilder1,
                                        Callable<T> objectBuilder2)

Builds two objects and ensures that they are equal.

Type Parameters:

T - type

Parameters:

objectBuilder1 - first object builder

objectBuilder2 - second object builder

assertEqualsImplementedCorrectly

public static void assertEqualsImplementedCorrectly(Object o1,
                                    Object o2)

Take two objects and ensure their are implemented correctly. Warnings are suppressed as this block of code will do things that normal developers are not supposed to do, but are needed to ensure that Object.equals(Object) is implemented correctly.

The generic check is not put in to allow testing with different classes

Parameters:

o1 - first object

o2 - second object

assertEqualsImplementedCorrectly

public static <T> void assertEqualsImplementedCorrectly(T o)

Take a single object and ensure its equality is implemented correctly.

Type Parameters:

T - type

Parameters:

o - object