org.dbunit.dataset.stream.IDataSetConsumer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbunit Show documentation

dbUnit is a JUnit extension (also usable from Ant and Maven) targeted for database-driven projects that, among other things, puts your database into a known state between test runs. This is an excellent way to avoid the myriad of problems that can occur when one test case corrupts the database and causes subsequent tests to fail or exacerbate the damage.

There is a newer version: 2.8.0

Show newest version

/*
 *
 * The DbUnit Database Testing Framework
 * Copyright (C)2002-2004, DbUnit.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
package org.dbunit.dataset.stream;

import org.dbunit.dataset.DataSetException;
import org.dbunit.dataset.ITableMetaData;


/**
 * Receive notification of the content of a dataset.
 *
 * @author Manuel Laflamme
 * @since Apr 17, 2003
 * @version $Revision: 398 $
 */
public interface IDataSetConsumer
{
    /**
     * Receive notification of the beginning of a dataset. This method is
     * invoked only once, before any other methods in this interface.
     */
    public void startDataSet() throws DataSetException;

    /**
     * Receive notification of the end of a dataset. This method is invoked only
     * once, and it will be the last method invoked in this interface.
     */
    public void endDataSet() throws DataSetException;

    /**
     * Receive notification of the beginning of a table. This method is invoked
     * at the beginning of every table in the dataset; there will be a
     * corresponding {@link #endDataSet} event for every startTable
     * event (even when the table is empty).
     * @param metaData the table metadata
     */
    public void startTable(ITableMetaData metaData) throws DataSetException;

    /**
     * Receive notification of the end of a table.
     */
    public void endTable() throws DataSetException;

    /**
     * Receive notification of a table row. This method is invoked to report
     * each row of a table.
     * @param values The row values.
     */
    public void row(Object[] values) throws DataSetException;
}