Package com.google.common.testing
Class EqualsTester
- java.lang.Object
-
- com.google.common.testing.EqualsTester
-
@Beta @GwtCompatible public final class EqualsTester extends Object
Tester for equals() and hashCode() methods of a class.The simplest use case is:
new EqualsTester().addEqualityGroup(foo).testEquals();
This tests
foo.equals(foo)
,foo.equals(null)
, and a few other operations.For more extensive testing, add multiple equality groups. Each group should contain objects that are equal to each other but unequal to the objects in any other group. For example:
new EqualsTester() .addEqualityGroup(new User("page"), new User("page")) .addEqualityGroup(new User("sergey")) .testEquals();
This tests:
- comparing each object against itself returns true
- comparing each object against null returns false
- comparing each object against an instance of an incompatible class returns false
- comparing each pair of objects within the same equality group returns true
- comparing each pair of objects from different equality groups returns false
- the hash codes of any two equal objects are equal
When a test fails, the error message labels the objects involved in the failed comparison as follows:
- "
[group
i, item
j]
" refers to the jth item in the ith equality group, where both equality groups and the items within equality groups are numbered starting from 1. When either a constructor argument or an equal object is provided, that becomes group 1.
- Since:
- 10.0
- Author:
- Jim McMaster, Jige Yu
-
-
Constructor Summary
Constructors Constructor Description EqualsTester()
Constructs an empty EqualsTester instance
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EqualsTester
addEqualityGroup(Object... equalityGroup)
AddsequalityGroup
with objects that are supposed to be equal to each other and not equal to any other equality groups added to this tester.EqualsTester
testEquals()
Run tests on equals method, throwing a failure on an invalid test
-
-
-
Constructor Detail
-
EqualsTester
public EqualsTester()
Constructs an empty EqualsTester instance
-
-
Method Detail
-
addEqualityGroup
public EqualsTester addEqualityGroup(Object... equalityGroup)
AddsequalityGroup
with objects that are supposed to be equal to each other and not equal to any other equality groups added to this tester.
-
testEquals
public EqualsTester testEquals()
Run tests on equals method, throwing a failure on an invalid test
-
-