com.aliasi.test.unit

Class Asserts

java.lang.Object

com.aliasi.test.unit.Asserts

public class Asserts
extends Object

Since:

Lingpipe3.8

Version:

3.8

Author:

Bob Carpenter

Method Summary

Modifier and Type	Method and Description
static void	assertComparableSelf(Comparable xc) Tests whether the first argument is equal to itself according to java.lang.Comparable.compareTo.
static void	assertComparableSelf(String msg, Comparable xc) Tests within a specified test case whether the first argument is equal to itself according to java.lang.Comparable.compareTo.
static void	assertEqualsArray(double[] xs, double[] ys, double tolerance) Tests that the two specified arrays are not null, the same length, and the element at each index is equal.
static void	assertEqualsArray(String msg, double[] xs, double[] ys, double tolerance) Tests that the two specified arrays are not null, the same length, and the element at each index is equal.
static void	assertEqualsArray2D(double[][] xss, double[][] yss, double tolerance)
static void	assertEqualsIterations(Iterator it1, Iterator it2) Tests that the two iterators return the same elements as compared by #assertEquals(Object,Object).
static void	assertEqualsIterations(String msg, Iterator it1, Iterator it2) Tests that the two iterators return the same elements as compared by #assertEquals(Object,Object), with the specified error message.
static void	assertFullEquals(Object x, Object y) Asserts that two objects are equal and they obey the subsequent requirements of the equality contract.
static void	assertFullEquals(String msg, Object x, Object y) Asserts within a specified test case that two objects are equal and they obey the subsequent requirements of the equality contract.
static void	assertFullLessThan(Comparable x, Comparable y) Tests whether the first argument is less than the second argument according to its Comparable.compareTo method, and vice-versa.
static void	assertFullLessThan(String msg, Comparable x, Comparable y) Tests within a specified test case whether the first argument is less than the second argument according to its Comparable.compareTo method, and vice-versa.
static void	assertFullNotEquals(Object x, Object y) Asserts that two objects are not equal and they obey the subsequent reqirements of the equality contract.
static void	assertFullNotEquals(String msg, Object x, Object y) Asserts within a specified test case that two objects are not equal and they obey the subsequent reqirements of the equality contract.
static void	assertFullSerialization(Object x) Asserts that the object may be serialized and deserialized and the result will be fully equal to this object in the sense defined by assertFullEquals(java.lang.Object, java.lang.Object).
static void	assertFullSerialization(String msg, Object x) Asserts within a specified test case that the object may be serialized and deserialized and the result will be fully equal to this object in the sense defined by assertFullEquals(java.lang.Object, java.lang.Object).
static <E> void	assertLess(Comparator<? super E> comp, E o1, E o2)
static void	assertNotEquals(Object x, Object y) Asserts that the two specified objects are not both null and not both non-null and equal.
static void	assertNotEquals(String msg, Object x, Object y) Asserts that the two specified objects are not both null and not both non-null and equal.
static void	assertNotSerializable(Object x)
static <E> void	assertSame(Comparator<? super E> comp, E o1, E o2)
static void	succeed() Provides a test success with the default message.
static void	succeed(String msg) Provides a test success with the specified message for this test case.

Methods inherited from class java.lang.Object

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

Method Detail

assertNotSerializable

public static void assertNotSerializable(Object x)

assertNotEquals

public static void assertNotEquals(Object x,
                                   Object y)

Asserts that the two specified objects are not both null and not both non-null and equal.

Parameters:

x - First object to test.

y - Second object to test.

assertNotEquals

public static void assertNotEquals(String msg,
                                   Object x,
                                   Object y)

Asserts that the two specified objects are not both null and not both non-null and equal.

Parameters:

msg - Message to return for failure of assertion.

x - First object to test.

y - Second object to test.

assertEqualsArray

public static void assertEqualsArray(double[] xs,
                                     double[] ys,
                                     double tolerance)

Tests that the two specified arrays are not null, the same length, and the element at each index is equal.

Parameters:

xs - First array to test.

ys - Second array to test.

tolerance - Tolerance of double equality test.

assertEqualsArray2D

public static void assertEqualsArray2D(double[][] xss,
                                       double[][] yss,
                                       double tolerance)

assertEqualsArray

public static void assertEqualsArray(String msg,
                                     double[] xs,
                                     double[] ys,
                                     double tolerance)

Tests that the two specified arrays are not null, the same length, and the element at each index is equal.

Parameters:

msg - Message to return if tests fial.

xs - First array to test.

ys - Second array to test.

tolerance - Tolerance of double equality test.

assertFullEquals

public static void assertFullEquals(Object x,
                                    Object y)

Asserts that two objects are equal and they obey the subsequent requirements of the equality contract. First, the objects must be symmetrically equal, so that both x.equals(y) and y.equals(x). In addition, their hash codes must be equivalent to pass this test.

Parameters:

x - First object to test for equality.

y - Second object to test for equality.

assertFullNotEquals

public static void assertFullNotEquals(Object x,
                                       Object y)

Asserts that two objects are not equal and they obey the subsequent reqirements of the equality contract. The objects must be symmetrically not equal, so that !x.equals(y) and !y.equals(x). Note that their hash codes may be equivalent.

Parameters:

x - First object to test for inequality.

y - Second object to test for inequality.

assertFullSerialization

public static void assertFullSerialization(Object x)

Asserts that the object may be serialized and deserialized and the result will be fully equal to this object in the sense defined by assertFullEquals(java.lang.Object, java.lang.Object).

Parameters:

x - Object to test for serialization.

assertFullLessThan

public static void assertFullLessThan(Comparable x,
                                      Comparable y)

Tests whether the first argument is less than the second argument according to its Comparable.compareTo method, and vice-versa. Also tests that the first and second arguments are self-equal using the same method.

Parameters:

x - Object that should be smaller.

y - Object that should be bigger.

assertComparableSelf

public static void assertComparableSelf(Comparable xc)

Tests whether the first argument is equal to itself according to java.lang.Comparable.compareTo. This also checks that the comparable is not equal to a fresh object according to this method, although a java.lang.ClassCastException is allowed to be thrown.

Parameters:

xc - Comparable to test for self equality and inequality with fresh object.

assertEqualsIterations

public static void assertEqualsIterations(Iterator it1,
                                          Iterator it2)

Tests that the two iterators return the same elements as compared by #assertEquals(Object,Object).

Parameters:

it1 - First iterator.

it2 - Second iterator.

assertEqualsIterations

public static void assertEqualsIterations(String msg,
                                          Iterator it1,
                                          Iterator it2)

Tests that the two iterators return the same elements as compared by #assertEquals(Object,Object), with the specified error message.

Parameters:

msg - Message to report along with the location of the difference.

it1 - First iterator.

it2 - Second iterator.

assertFullEquals

public static void assertFullEquals(String msg,
                                    Object x,
                                    Object y)

Asserts within a specified test case that two objects are equal and they obey the subsequent requirements of the equality contract. First, the objects must be symmetrically equal, so that both x.equals(y) and y.equals(x). In addition, their hash codes must be equivalent to pass this test. Although recommend rather than required by java.util.Comparable, if either object is comparable, then its natural ordering is tested for consistency with equals.

Parameters:

msg - Message prefix to print upon failure.

x - First object to test for equality.

y - Second object to test for equality.

assertFullNotEquals

public static void assertFullNotEquals(String msg,
                                       Object x,
                                       Object y)

Asserts within a specified test case that two objects are not equal and they obey the subsequent reqirements of the equality contract. The objects must be symmetrically not equal, so that !x.equals(y) and !y.equals(x). Note that their hash codes may be equivalent. If either argument object is an instance of Comparable then its comparison result must also be non-zero against the other object.

Parameters:

msg - Message prefix to print upon failure.

x - First object to test for inequality.

y - Second object to test for inequality.

assertFullSerialization

public static void assertFullSerialization(String msg,
                                           Object x)

Asserts within a specified test case that the object may be serialized and deserialized and the result will be fully equal to this object in the sense defined by assertFullEquals(java.lang.Object, java.lang.Object).

Parameters:

msg - Message prefix to print upon failure.

x - Object to test for serialization.

assertFullLessThan

public static void assertFullLessThan(String msg,
                                      Comparable x,
                                      Comparable y)

Tests within a specified test case whether the first argument is less than the second argument according to its Comparable.compareTo method, and vice-versa. Also tests that the first and second arguments are self-equal using the same method.

Parameters:

msg - Message prefix to print upon failure.

x - Object that should be smaller.

y - Object that should be bigger.

assertComparableSelf

public static void assertComparableSelf(String msg,
                                        Comparable xc)

Tests within a specified test case whether the first argument is equal to itself according to java.lang.Comparable.compareTo. This also checks that the comparable is not equal to a fresh object according to this method, although a java.lang.ClassCastException is allowed to be thrown.

Parameters:

msg - Message prefix to print upon failure.

xc - Comparable to test for self equality and inequality with fresh object.

succeed

public static void succeed()

Provides a test success with the default message.

succeed

public static void succeed(String msg)

Provides a test success with the specified message for this test case.

Parameters:

msg - Message prefix to print on failure.

assertLess

public static <E> void assertLess(Comparator<? super E> comp,
                                  E o1,
                                  E o2)

Type Parameters:

E - type of objects being compared

assertSame

public static <E> void assertSame(Comparator<? super E> comp,
                                  E o1,
                                  E o2)

Type Parameters:

E - type of objects being compared