net.sf.jguiraffe

Class JGuiraffeTestHelper

java.lang.Object

net.sf.jguiraffe.JGuiraffeTestHelper

public class JGuiraffeTestHelper
extends Object

A helper class with functionality that can be used by test classes.

This class contains a set of utility methods that are useful for many test classes. Because of that this functionality was extracted into its own utility class.

Version:

$Id: JGuiraffeTestHelper.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Constructor Summary

Constructors

Constructor and Description
JGuiraffeTestHelper()

Method Summary

Modifier and Type	Method and Description
static void	checkEquals(Object o1, Object o2, boolean expected) Tests the implementation of equals() and (partly) hashCode().
static boolean	collectionEquals(Collection<?> c1, Collection<?> c2) Tests whether the specified collections are equal.
static Date	createDate(int year, int month, int day) Helper method for creating a date object based on the given year, month, and day.
static ByteArrayOutputStream	readStream(InputStream in, boolean close) Reads the content of the specified input stream and provides it as byte array stream.
static <T> T	serialize(T obj) Helper method for serializing an object.
static void	testTrivialEquals(Object obj) Helper method for performing some trivial checks of the equals() method of an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JGuiraffeTestHelper

public JGuiraffeTestHelper()

Method Detail

checkEquals

public static void checkEquals(Object o1,
                               Object o2,
                               boolean expected)

Tests the implementation of equals() and (partly) hashCode(). The passed in first object is compared with the second with the expected result. Then it is checked whether equals() is symmetric. If the expected result is true, the hash codes must also match.

Parameters:

o1 - the first object (must not be null)

o2 - the second object (can be null)

expected - the expected result of the comparison

testTrivialEquals

public static void testTrivialEquals(Object obj)

Helper method for performing some trivial checks of the equals() method of an object. This method checks

• whether the object equals itself
• whether equals() for a null argument returns false
• whether equals() for an arbitrary object returns false

Parameters:

obj - the object to check (must not be null

readStream

public static ByteArrayOutputStream readStream(InputStream in,
                                               boolean close)

Reads the content of the specified input stream and provides it as byte array stream. This may be useful for reading the content of test files. The close parameter determines whether the input stream is to be closed after it was completely read. Occurring exceptions are re-thrown as runtime exceptions.

Parameters:

in - the input stream to read

close - a flag whether the stream is to be closed

Returns:

a byte array stream with the data read from the input stream

createDate

public static Date createDate(int year,
                              int month,
                              int day)

Helper method for creating a date object based on the given year, month, and day. This method internally creates a Calendar, populates it with the given date values, and returns the corresponding Date.

Parameters:

year - the year

month - the month (note: this is 0-based!)

day - the day

Returns:

the date object

collectionEquals

public static boolean collectionEquals(Collection<?> c1,
                                       Collection<?> c2)

Tests whether the specified collections are equal. This method can be used for instance when dealing with unmodifiable collections, which do not implement equals(). All comparisons are null safe.

Parameters:

c1 - collection 1

c2 - collection 2

Returns:

a flag whether these collections are equal

serialize

public static <T> T serialize(T obj)
                       throws IOException

Helper method for serializing an object. This method can be used for serialization tests. The passed in object is serialized (to an in-memory stream) and then read again. The copy is returned. Exceptions are thrown if serialization fails.

Type Parameters:

T - the type of the object

Parameters:

obj - the object to be serialized

Returns:

the copy created through serialization

Throws:

IOException - if an IO exception occurs (typically because the object cannot be serialized)