com.helger.commons.mock

Class CommonsTestHelper

java.lang.Object

com.helger.commons.mock.CommonsTestHelper

@Immutable
public final class CommonsTestHelper
extends Object

This class contains default test methods to test the correctness of implementations of standard methods.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
static <DATATYPE> void	testDefaultImplementationWithDifferentContentObject(DATATYPE aObject1, DATATYPE aObject2) Check if two different objects are different to each other.
static <DATATYPE> void	testDefaultImplementationWithEqualContentObject(DATATYPE aObject1, DATATYPE aObject2) Check if two different objects (who may not be the same) are equal to each other.
static <DATATYPE extends Serializable> DATATYPE	testDefaultSerialization(DATATYPE aSerializable) Test the serializability of objects.
static void	testGetClone(ICloneable<?> aCloneable) Test if the implementation ICloneable is OK.
static int	testIfAllSPIFilesAreValid(String sBaseDir, boolean bContinueOnError)
static int	testIfAllSPIImplementationsAreValid()
static int	testIfAllSPIImplementationsAreValid(boolean bContinueOnError)
static void	testInParallel(int nCalls, IThrowingRunnable<? extends Throwable> aRunnable) Run something in parallel
static void	testInParallel(int nCalls, Runnable aRunnable) Run something in parallel
static <T> T	testMicroTypeConversion(T aObj) Test if the MicroTypeConverter is OK.
static void	testToStringImplementation(Object aObject) Test the toString implementation of the passed object.

Methods inherited from class java.lang.Object

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

Method Detail

testToStringImplementation

public static void testToStringImplementation(@Nonnull
                                              Object aObject)

Test the toString implementation of the passed object. It may not be empty, and consistent.

Parameters:

aObject - The object to be tested.

testDefaultImplementationWithEqualContentObject

public static <DATATYPE> void testDefaultImplementationWithEqualContentObject(@Nonnull
                                                                              DATATYPE aObject1,
                                                                              @Nonnull
                                                                              DATATYPE aObject2)

Check if two different objects (who may not be the same) are equal to each other. Checks toString, equals and hashCode.

Type Parameters:

DATATYPE - The data type to be used

Parameters:

aObject1 - First object. May not be null.

aObject2 - Second object. May not be null.

testDefaultImplementationWithDifferentContentObject

public static <DATATYPE> void testDefaultImplementationWithDifferentContentObject(@Nonnull
                                                                                  DATATYPE aObject1,
                                                                                  @Nonnull
                                                                                  DATATYPE aObject2)

Check if two different objects are different to each other. Checks toString, equals and hashCode.

Type Parameters:

DATATYPE - The data type to be used

Parameters:

aObject1 - First object. May not be null.

aObject2 - Second object. May not be null.

testDefaultSerialization

@Nonnull
public static <DATATYPE extends Serializable> DATATYPE testDefaultSerialization(@Nonnull
                                                                                          DATATYPE aSerializable)

Test the serializability of objects. First writes the object to a byte array stream, and then tries to rebuild it from there. After reading it performs an equals check using testDefaultImplementationWithEqualContentObject(Object, Object)

Type Parameters:

DATATYPE - The type of object to be serialized.

Parameters:

aSerializable - The object to be written and read

Returns:

The newly read object

testGetClone

public static void testGetClone(@Nonnull
                                ICloneable<?> aCloneable)

Test if the implementation ICloneable is OK. It creates a clone and than uses testDefaultImplementationWithEqualContentObject(Object, Object) to check for equality.

Parameters:

aCloneable - The cloneable object to test

testMicroTypeConversion

public static <T> T testMicroTypeConversion(@Nonnull
                                            T aObj)

Test if the MicroTypeConverter is OK. It converts it to XML and back and than uses testDefaultImplementationWithEqualContentObject(Object, Object) to check for equality.

Type Parameters:

T - The data type to be used and returned

Parameters:

aObj - The object to test

Returns:

The object read after conversion

testInParallel

public static void testInParallel(@Nonnegative
                                  int nCalls,
                                  @Nonnull
                                  Runnable aRunnable)

Run something in parallel

Parameters:

nCalls - The number of invocations of the passed runnable. Must be ≥ 0.

aRunnable - The runnable to execute. May not be null.

testInParallel

public static void testInParallel(@Nonnegative
                                  int nCalls,
                                  @Nonnull
                                  IThrowingRunnable<? extends Throwable> aRunnable)

Run something in parallel

Parameters:

nCalls - The number of invocations of the passed runnable. Must be ≥ 0.

aRunnable - The runnable to execute. May not be null.

testIfAllSPIFilesAreValid

@Nonnegative
public static int testIfAllSPIFilesAreValid(@Nonnull
                                                          String sBaseDir,
                                                          boolean bContinueOnError)
                                                   throws Exception

Throws:

Exception

testIfAllSPIImplementationsAreValid

@Nonnegative
public static int testIfAllSPIImplementationsAreValid()
                                                             throws Exception

Throws:

Exception

testIfAllSPIImplementationsAreValid

@Nonnegative
public static int testIfAllSPIImplementationsAreValid(boolean bContinueOnError)
                                                             throws Exception

Throws:

Exception