Package org.dbunit

Class Assertion

java.lang.Object

org.dbunit.Assertion

public class Assertion
extends Object

Provides static methods for the most common DbUnit assertion needs. Although the methods are static, they rely on a DbUnitAssert instance to do the work. So, if you need to customize this class behavior, you can create your own DbUnitAssert extension.

Since:

1.3 (Mar 22, 2002)

Version:

$Revision$ $Date$

Author:

Manuel Laflamme, Felipe Leme (dbunit@felipeal.net), Last changed by: $Author$

Method Summary

Modifier and Type	Method	Description
static void	assertEquals(IDataSet expectedDataSet, IDataSet actualDataSet)	Asserts that the two specified datasets are equal.
static void	assertEquals(IDataSet expectedDataSet, IDataSet actualDataSet, FailureHandler failureHandler)	Asserts that the two specified datasets are equal.
static void	assertEquals(ITable expectedTable, ITable actualTable)	Asserts that the two specified tables are equal.
static void	assertEquals(ITable expectedTable, ITable actualTable, FailureHandler failureHandler)	Asserts that the two specified tables are equal.
static void	assertEquals(ITable expectedTable, ITable actualTable, Column[] additionalColumnInfo)	Asserts that the two specified tables are equal.
static void	assertEqualsByQuery(IDataSet expectedDataset, IDatabaseConnection connection, String sqlQuery, String tableName, String[] ignoreCols)	Asserts that the specified dataset table matches the given query's result, ignoring the given columns.
static void	assertEqualsByQuery(ITable expectedTable, IDatabaseConnection connection, String tableName, String sqlQuery, String[] ignoreCols)	Asserts that the specified table matches the given query's result, ignoring the given columns.
static void	assertEqualsIgnoreCols(IDataSet expectedDataset, IDataSet actualDataset, String tableName, String[] ignoreCols)	Asserts that the two specified datasets' tables are equal, ignoring the given columns.
static void	assertEqualsIgnoreCols(ITable expectedTable, ITable actualTable, String[] ignoreCols)	Asserts that the two specified tables are equal, ignoring the given columns.
static void	assertWithValueComparer(IDataSet expectedDataSet, IDataSet actualDataSet, ValueComparer defaultValueComparer, Map<String,Map<String,ValueComparer>> tableColumnValueComparers)	Asserts that the two specified datasets are equal, using the given value comparers.
static void	assertWithValueComparer(IDataSet expectedDataSet, IDataSet actualDataSet, FailureHandler failureHandler, ValueComparer defaultValueComparer, Map<String,Map<String,ValueComparer>> tableColumnValueComparers)	Asserts that the two specified datasets are equal, using the given value comparers.
static void	assertWithValueComparer(ITable expectedTable, ITable actualTable, ValueComparer defaultValueComparer, Map<String,ValueComparer> columnValueComparers)	Asserts that the two specified tables are equal, using the given value comparers.
static void	assertWithValueComparer(ITable expectedTable, ITable actualTable, FailureHandler failureHandler, ValueComparer defaultValueComparer, Map<String,ValueComparer> columnValueComparers)	Asserts that the two specified tables are equal, using the given value comparers.
static void	assertWithValueComparer(ITable expectedTable, ITable actualTable, Column[] additionalColumnInfo, ValueComparer defaultValueComparer, Map<String,ValueComparer> columnValueComparers)	Asserts that the two specified tables are equal, using the given value comparers.
static DbUnitAssert	getEqualsInstance()	Returns the shared DbUnitAssert instance used for equals-based comparisons.
static DbUnitValueComparerAssert	getValueCompareInstance()	Returns the shared DbUnitValueComparerAssert instance used for value-comparer-based comparisons.

Methods inherited from class java.lang.Object

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

Method Details

assertEqualsIgnoreCols

public static void assertEqualsIgnoreCols(IDataSet expectedDataset,
 IDataSet actualDataset,
 String tableName,
 String[] ignoreCols)
                                   throws DatabaseUnitException

Asserts that the two specified datasets' tables are equal, ignoring the given columns.

Parameters:

expectedDataset - dataset containing the expected results.

actualDataset - dataset containing the actual results.

tableName - name of the table to compare.

ignoreCols - columns to ignore during comparison.

Throws:

DatabaseUnitException - if an error occurs during comparison.

See Also:

• DbUnitAssert.assertEqualsIgnoreCols(IDataSet, IDataSet, String, String[])

assertEqualsIgnoreCols

public static void assertEqualsIgnoreCols(ITable expectedTable,
 ITable actualTable,
 String[] ignoreCols)
                                   throws DatabaseUnitException

Asserts that the two specified tables are equal, ignoring the given columns.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

ignoreCols - columns to ignore during comparison.

Throws:

DatabaseUnitException - if an error occurs during comparison.

See Also:

• DbUnitAssert.assertEqualsIgnoreCols(ITable, ITable, String[])

assertEqualsByQuery

public static void assertEqualsByQuery(IDataSet expectedDataset,
 IDatabaseConnection connection,
 String sqlQuery,
 String tableName,
 String[] ignoreCols)
                                throws DatabaseUnitException,
SQLException

Asserts that the specified dataset table matches the given query's result, ignoring the given columns.

Parameters:

expectedDataset - dataset containing the expected results.

connection - connection used to query the actual results.

sqlQuery - SQL query used to obtain the actual results.

tableName - name of the table being compared.

ignoreCols - columns to ignore during comparison.

Throws:

DatabaseUnitException - if an error occurs during comparison.

SQLException - if an error occurs while executing the query.

See Also:

• DbUnitAssert.assertEqualsByQuery(IDataSet, IDatabaseConnection, String, String, String[])

assertEqualsByQuery

public static void assertEqualsByQuery(ITable expectedTable,
 IDatabaseConnection connection,
 String tableName,
 String sqlQuery,
 String[] ignoreCols)
                                throws DatabaseUnitException,
SQLException

Asserts that the specified table matches the given query's result, ignoring the given columns.

Parameters:

expectedTable - table containing the expected results.

connection - connection used to query the actual results.

tableName - name of the table being compared.

sqlQuery - SQL query used to obtain the actual results.

ignoreCols - columns to ignore during comparison.

Throws:

DatabaseUnitException - if an error occurs during comparison.

SQLException - if an error occurs while executing the query.

See Also:

• DbUnitAssert.assertEqualsByQuery(ITable, IDatabaseConnection, String, String, String[])

assertEquals

public static void assertEquals(IDataSet expectedDataSet,
 IDataSet actualDataSet)
                         throws DatabaseUnitException

Asserts that the two specified datasets are equal.

Parameters:

expectedDataSet - dataset containing the expected results.

actualDataSet - dataset containing the actual results.

Throws:

DatabaseUnitException - if an error occurs during comparison.

See Also:

• DbUnitAssert.assertEquals(IDataSet, IDataSet)

assertEquals

public static void assertEquals(IDataSet expectedDataSet,
 IDataSet actualDataSet,
 FailureHandler failureHandler)
                         throws DatabaseUnitException

Asserts that the two specified datasets are equal.

Parameters:

expectedDataSet - dataset containing the expected results.

actualDataSet - dataset containing the actual results.

failureHandler - the failure handler used to report mismatches.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.4

See Also:

• DbUnitAssert.assertEquals(IDataSet, IDataSet, FailureHandler)

assertEquals

public static void assertEquals(ITable expectedTable,
 ITable actualTable)
                         throws DatabaseUnitException

Asserts that the two specified tables are equal.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

Throws:

DatabaseUnitException - if an error occurs during comparison.

See Also:

• DbUnitAssert.assertEquals(ITable, ITable)

assertEquals

public static void assertEquals(ITable expectedTable,
 ITable actualTable,
 Column[] additionalColumnInfo)
                         throws DatabaseUnitException

Asserts that the two specified tables are equal.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

additionalColumnInfo - additional columns to include in failure messages.

Throws:

DatabaseUnitException - if an error occurs during comparison.

See Also:

• DbUnitAssert.assertEquals(ITable, ITable, Column[])

assertEquals

public static void assertEquals(ITable expectedTable,
 ITable actualTable,
 FailureHandler failureHandler)
                         throws DatabaseUnitException

Asserts that the two specified tables are equal.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

failureHandler - the failure handler used to report mismatches.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.4

See Also:

• DbUnitAssert.assertEquals(ITable, ITable, FailureHandler)

assertWithValueComparer

public static void assertWithValueComparer(IDataSet expectedDataSet,
 IDataSet actualDataSet,
 ValueComparer defaultValueComparer,
 Map<String,Map<String,ValueComparer>> tableColumnValueComparers)
                                    throws DatabaseUnitException

Asserts that the two specified datasets are equal, using the given value comparers.

Parameters:

expectedDataSet - dataset containing the expected results.

actualDataSet - dataset containing the actual results.

defaultValueComparer - the value comparer used when no more specific comparer is configured.

tableColumnValueComparers - the per-table, per-column value comparers to use.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.6.0

See Also:

• DbUnitValueComparerAssert.assertWithValueComparer(IDataSet, IDataSet, ValueComparer, Map)

assertWithValueComparer

public static void assertWithValueComparer(ITable expectedTable,
 ITable actualTable,
 ValueComparer defaultValueComparer,
 Map<String,ValueComparer> columnValueComparers)
                                    throws DatabaseUnitException

Asserts that the two specified tables are equal, using the given value comparers.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

defaultValueComparer - the value comparer used when no more specific comparer is configured.

columnValueComparers - the per-column value comparers to use.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.6.0

See Also:

• DbUnitValueComparerAssert.assertWithValueComparer(ITable, ITable, ValueComparer, Map)

assertWithValueComparer

public static void assertWithValueComparer(IDataSet expectedDataSet,
 IDataSet actualDataSet,
 FailureHandler failureHandler,
 ValueComparer defaultValueComparer,
 Map<String,Map<String,ValueComparer>> tableColumnValueComparers)
                                    throws DatabaseUnitException

Asserts that the two specified datasets are equal, using the given value comparers.

Parameters:

expectedDataSet - dataset containing the expected results.

actualDataSet - dataset containing the actual results.

failureHandler - the failure handler used to report mismatches.

defaultValueComparer - the value comparer used when no more specific comparer is configured.

tableColumnValueComparers - the per-table, per-column value comparers to use.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.6.0

See Also:

• DbUnitAssertBase.assertWithValueComparer(IDataSet, IDataSet, FailureHandler, ValueComparer, Map)

assertWithValueComparer

public static void assertWithValueComparer(ITable expectedTable,
 ITable actualTable,
 Column[] additionalColumnInfo,
 ValueComparer defaultValueComparer,
 Map<String,ValueComparer> columnValueComparers)
                                    throws DatabaseUnitException

Asserts that the two specified tables are equal, using the given value comparers.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

additionalColumnInfo - additional columns to include in failure messages.

defaultValueComparer - the value comparer used when no more specific comparer is configured.

columnValueComparers - the per-column value comparers to use.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.6.0

See Also:

• DbUnitValueComparerAssert.assertWithValueComparer(ITable, ITable, Column[], ValueComparer, Map)

assertWithValueComparer

public static void assertWithValueComparer(ITable expectedTable,
 ITable actualTable,
 FailureHandler failureHandler,
 ValueComparer defaultValueComparer,
 Map<String,ValueComparer> columnValueComparers)
                                    throws DatabaseUnitException

Asserts that the two specified tables are equal, using the given value comparers.

Parameters:

expectedTable - table containing the expected results.

actualTable - table containing the actual results.

failureHandler - the failure handler used to report mismatches.

defaultValueComparer - the value comparer used when no more specific comparer is configured.

columnValueComparers - the per-column value comparers to use.

Throws:

DatabaseUnitException - if an error occurs during comparison.

Since:

2.6.0

See Also:

• DbUnitAssertBase.assertWithValueComparer(ITable, ITable, FailureHandler, ValueComparer, Map)

getEqualsInstance

public static DbUnitAssert getEqualsInstance()

Returns the shared DbUnitAssert instance used for equals-based comparisons.

Returns:

the shared DbUnitAssert instance.

getValueCompareInstance

public static DbUnitValueComparerAssert getValueCompareInstance()

Returns the shared DbUnitValueComparerAssert instance used for value-comparer-based comparisons.

Returns:

the shared DbUnitValueComparerAssert instance.