nl.vpro.test.jqwik

Interface BasicObjectTest<E>

All Known Subinterfaces:

ComparableTest<E>

public interface BasicObjectTest<E>

Basic tests on Object.equals(Object), Object.hashCode() and Object.toString(), which must probably be valid for _any_ override of those.

Since:

2.22

Author:

Michiel Meeuwissen

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATAPOINTS
static String	EQUAL_DATAPOINTS
static String	NONNULL_DATAPOINTS

Method Summary

Modifier and Type	Method and Description
net.jqwik.api.Arbitrary<? extends E>	datapoints()
default net.jqwik.api.Arbitrary<? extends nl.vpro.util.Pair<E,E>>	equalDatapoints()
default void	equalsIsConsistent(E x, E y) For any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
default void	equalsIsReflexive(E x) For any non-null reference value x, x.equals(x) should return true
default void	equalsIsSymmetric(E x, E y) For any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
default void	equalsIsTransitive(nl.vpro.util.Pair<E,E> p1, nl.vpro.util.Pair<E,E> p2) For any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
default void	equalsReturnFalseOnNull(E x) For any non-null reference value x, x.equals(null); should return false.
default void	hashCodeIsConsistentWithEquals(nl.vpro.util.Pair<E,E> pair) If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
default void	hashCodeIsSelfConsistent(E x) Whenever it is invoked on the same object more than once the hashCode() method must consistently return the same integer.
default net.jqwik.api.Arbitrary<? extends E>	nonNullDatapoints()
default void	toString(E object) toString of an object may be anything, but it may not throw exceptions.

Field Detail

DATAPOINTS

static final String DATAPOINTS

See Also:

Constant Field Values

NONNULL_DATAPOINTS

static final String NONNULL_DATAPOINTS

See Also:

Constant Field Values

EQUAL_DATAPOINTS

static final String EQUAL_DATAPOINTS

See Also:

Constant Field Values

Method Detail

equalsIsReflexive

@Property
default void equalsIsReflexive(@ForAll(value="nonNullDatapoints")
                                         E x)

For any non-null reference value x, x.equals(x) should return true

equalsIsSymmetric

@Property
default void equalsIsSymmetric(@ForAll(value="nonNullDatapoints")
                                         E x,
                                         @ForAll(value="nonNullDatapoints")
                                         E y)

For any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.

equalsIsTransitive

@Property
default void equalsIsTransitive(@ForAll(value="equalDatapoints")
                                          nl.vpro.util.Pair<E,E> p1,
                                          @ForAll(value="equalDatapoints")
                                          nl.vpro.util.Pair<E,E> p2)

For any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

equalsIsConsistent

@Property
default void equalsIsConsistent(@ForAll(value="nonNullDatapoints")
                                          E x,
                                          @ForAll(value="datapoints")
                                          E y)

For any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.

equalsReturnFalseOnNull

@Property
default void equalsReturnFalseOnNull(@ForAll(value="nonNullDatapoints")
                                               E x)

For any non-null reference value x, x.equals(null); should return false.

hashCodeIsSelfConsistent

@Property
default void hashCodeIsSelfConsistent(@ForAll(value="nonNullDatapoints")
                                                E x)

Whenever it is invoked on the same object more than once the hashCode() method must consistently return the same integer.

hashCodeIsConsistentWithEquals

@Property
default void hashCodeIsConsistentWithEquals(@ForAll(value="equalDatapoints")
                                                      nl.vpro.util.Pair<E,E> pair)

If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.

toString

@Property
default void toString(@ForAll(value="nonNullDatapoints")
                                E object)

toString of an object may be anything, but it may not throw exceptions.

datapoints

@Provide
net.jqwik.api.Arbitrary<? extends E> datapoints()

equalDatapoints

@Provide
default net.jqwik.api.Arbitrary<? extends nl.vpro.util.Pair<E,E>> equalDatapoints()

nonNullDatapoints

@Provide
default net.jqwik.api.Arbitrary<? extends E> nonNullDatapoints()