Logo Search packages:      
Sourcecode: cdk version File versions  Download package

IChemObjectReader.java
/* $Revision$ $Author$ $Date$
 *
 * Copyright (C) 2000-2007  Egon Willighagen <egonw@users.sf.net>
 *
 * Contact: cdk-devel@lists.sourceforge.net
 *
 * 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.InputStream;
import java.io.Reader;

import org.openscience.cdk.exception.CDKException;

/**
 * This class is the interface that all IO readers should implement.
 *
 * @cdk.module io
 * @cdk.githash
 *
 * @author     Egon Willighagen <egonw@users.sf.net>
 **/
00040 public interface IChemObjectReader extends IChemObjectIO {

00042       public enum Mode {
            /** Only fail on serious format problems */
00044             RELAXED,
            /** Fail on any format problem */
            STRICT
      }

    /**
     * Sets the Reader from which this ChemObjectReader should read
     * the contents.
     */
    public void setReader(Reader reader) throws CDKException;

    /**
     * Sets the InputStream from which this ChemObjectReader should read
     * the contents.
     */
    public void setReader(InputStream reader) throws CDKException;
    
    /**
     * Sets the reader mode. If Mode.STRICT, then the reader will fail on
     * any problem in the format of the read file, instead of trying to
     * recover from that.
     * 
     * @param mode
     */
    public void setReaderMode(Mode mode);
}


Generated by  Doxygen 1.6.0   Back to index