org.openscience.cdk.io.IChemObjectWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk-io Show documentation
There is a newer version: 2.10
/* Copyright (C) 1997-2007  The Chemistry Development Kit (CDK) project
 *
 * Contact: [email protected]
 *
 * This program 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.
 * All we ask is that proper credit is given for our work, which includes
 * - but is not limited to - adding the above copyright notice to the beginning
 * of your source code files, and to any copyright notice that you may distribute
 * with programs based on this work.
 *
 * This program 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 program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *  */
package org.openscience.cdk.io;

import java.io.OutputStream;
import java.io.Writer;

import org.openscience.cdk.exception.CDKException;
import org.openscience.cdk.interfaces.IChemObject;

/**
 * This class is the interface that all IO writers should implement.
 * Programs need only care about this interface for any kind of IO.
 *
 * Currently, database IO and file IO is supported. Internet IO is
 * expected.
 *
 * @cdk.module io
 * @cdk.githash
 */
public interface IChemObjectWriter extends IChemObjectIO {

    /**
     * Writes the content of "object" to output.
     *
     * @param  object    the object of which the content is outputed
     *
     * @exception CDKException is thrown if the output
     *            does not support the data in the object
     */
    public void write(IChemObject object) throws CDKException;

    /**
     * Sets the Writer from which this ChemObjectWriter should write
     * the contents.
     */
    public void setWriter(Writer writer) throws CDKException;

    /**
     * Sets the OutputStream from which this ChemObjectWriter should write
     * the contents.
     */
    public void setWriter(OutputStream writer) throws CDKException;

}