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

Show more of this group Show more artifacts with this name
Show all versions of xmlc-all-runtime Show documentation

old 2002 version of xmlc-xmlc-all-runtime

The 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;


/**
 * Interface for reading a dataset using callback.
 *
 * @author Manuel Laflamme
 * @since Apr 17, 2003
 * @version $Revision$
 */
public interface IDataSetProducer
{
    public void setConsumer(IDataSetConsumer consumer) throws DataSetException;

    /**
     * Process this dataset source. During the processing, the IDataSetProducer
     * will provide information about the dataset through the specified event
     * listener.
     * 
     * This method is synchronous: it will not return until processing has ended.
     * If a client application wants to terminate parsing early, it should
     * throw an exception from the listener.
     */
    public void produce() throws DataSetException;
}