nl.vpro.test.jqwik

Interface ComparableTest<E extends Comparable<E>>

All Superinterfaces:

BasicObjectTest<E>

public interface ComparableTest<E extends Comparable<E>>
extends BasicObjectTest<E>

Since:

2.22

Author:

Michiel Meeuwissen

Field Summary

Fields inherited from interface nl.vpro.test.jqwik.BasicObjectTest

DATAPOINTS, EQUAL_DATAPOINTS, NONNULL_DATAPOINTS

Method Summary

Modifier and Type	Method and Description
default void	compareToIsAntiCommutative(E x, E y) The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y.
default void	compareToIsTransitiveBigger(E x, E y, E z) The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.
default void	compareToIsTransitiveEquals(E x, E y, E z)
default void	compareToIsTransitiveSmaller(E x, E y, E z)
default void	compareToNull(E x)
default void	equalsConsistentWithComparable(nl.vpro.util.Pair<E,E> pair) This test whether compareTo Comparable.compareTo(Object) returns 0 iff if two object are equal.

Methods inherited from interface nl.vpro.test.jqwik.BasicObjectTest

datapoints, equalDatapoints, equalsIsConsistent, equalsIsReflexive, equalsIsSymmetric, equalsIsTransitive, equalsReturnFalseOnNull, hashCodeIsConsistentWithEquals, hashCodeIsSelfConsistent, nonNullDatapoints, toString

Method Detail

equalsConsistentWithComparable

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

This test whether compareTo Comparable.compareTo(Object) returns 0 iff if two object are equal. TODO: This is not an absolute requirement, in some cases you may want to compareTo to zero even if two objects are not exactly equal.

compareToNull

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

compareToIsAntiCommutative

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

The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y.

compareToIsTransitiveBigger

@Property(maxDiscardRatio=1000)
default void compareToIsTransitiveBigger(@ForAll(value="nonNullDatapoints")
                                                                         E x,
                                                                         @ForAll(value="nonNullDatapoints")
                                                                         E y,
                                                                         @ForAll(value="nonNullDatapoints")
                                                                         E z)

The implementor must also ensure that the relation is transitive: (x.compareTo(y)>0 && y.compareTo(z)>0) implies x.compareTo(z)>0.

compareToIsTransitiveSmaller

@Property(maxDiscardRatio=1000)
default void compareToIsTransitiveSmaller(@ForAll(value="nonNullDatapoints")
                                                                          E x,
                                                                          @ForAll(value="nonNullDatapoints")
                                                                          E y,
                                                                          @ForAll(value="nonNullDatapoints")
                                                                          E z)

compareToIsTransitiveEquals

@Property(maxDiscardRatio=1000)
default void compareToIsTransitiveEquals(@ForAll(value="nonNullDatapoints")
                                                                         E x,
                                                                         @ForAll(value="nonNullDatapoints")
                                                                         E y,
                                                                         @ForAll(value="nonNullDatapoints")
                                                                         E z)