DbDumpCommand.java

/**
 * Copyright (C) 2011  JTalks.org Team
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.jtalks.poulpe.util.databasebackup.dbdump;

import java.io.IOException;
import java.io.OutputStream;
import java.sql.SQLException;

/**
 * A database dump command is responsible for provide a piece of certain dump information such as SQL CREATE statement,
 * INSERT statement etc. A full database dump can be obtained by executing a set of DbDumpCommands where every command
 * in the set is responsible for a certain piece of information.
 * 
 * @author Evgeny Surovtsev
 * 
 */
public interface DbDumpCommand {
    /**
     * Executes command and push result into {@link OutputStream}.
     * 
     * @param output
     *            the result of the command will be saved into the output stream.
     * @throws SQLException
     *             if a SQL error occurs.
     * @throws IOException
     *             if a I/O error occurs.
     */
    void execute(OutputStream output) throws SQLException, IOException;
}