View Javadoc
1   /*
2    *
3    *  The DbUnit Database Testing Framework
4    *  Copyright (C)2002-2008, DbUnit.org
5    *
6    *  This library is free software; you can redistribute it and/or
7    *  modify it under the terms of the GNU Lesser General Public
8    *  License as published by the Free Software Foundation; either
9    *  version 2.1 of the License, or (at your option) any later version.
10   *
11   *  This library is distributed in the hope that it will be useful,
12   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14   *  Lesser General Public License for more details.
15   *
16   *  You should have received a copy of the GNU Lesser General Public
17   *  License along with this library; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   *
20   */
21  package org.dbunit.assertion;
22  
23  import org.dbunit.dataset.ITable;
24  
25  /**
26   * Handles the failure of an assertion.
27   * 
28   * @author gommma (gommma AT users.sourceforge.net)
29   * @author Last changed by: $Author$
30   * @version $Revision$ $Date$
31   * @since 2.4.0
32   */
33  public interface FailureHandler extends DifferenceListener, FailureFactory
34  {
35  
36      /**
37       * Returns a string to be appended to the assertion failure message. Is used to 
38       * provide some more information about a failure (for example to print out some
39       * PK columns for identifying the failed rows in the DB).
40       * @param expectedTable
41       * @param actualTable
42       * @param row The row for which the assertion failed
43       * @param columnName The column for which the assertion failed
44       * @return A string that is appended to the assertion failure message
45       */
46      public String getAdditionalInfo(ITable expectedTable, ITable actualTable,
47              int row, String columnName);
48  
49  
50  }