IChemObjectReaderErrorHandler.java

/* Copyright (C) 2010  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;


/**
 * Interface for classes aimed to handle {@link IChemObjectReader} errors.
 *
 * @cdk.module io
 * @cdk.githash
 *
 * @author     Egon Willighagen <egonw@users.sf.net>
 */
public interface IChemObjectReaderErrorHandler {

    /**
     * Method that should react on an error message send by an 
     * {@link IChemObjectReader}.
     *
     * @param message Error found while reading.
     */
    public void handleError(String message);

    /**
     * Method that should react on an error message send by an 
     * {@link IChemObjectReader}.
     *
     * @param message   Error found while reading.
     * @param exception Exception thrown while reading.
     */
    public void handleError(String message, Exception exception);

    /**
     * Method that should react on an error message send by an 
     * {@link IChemObjectReader}.
     *
     * @param message  Error found while reading.
     * @param row      Row in the file where the error is found.
     * @param colStart Start column in the file where the error is found.
     * @param colEnd   End column in the file where the error is found.
     */
    public void handleError(String message, int row, int colStart, int colEnd);

    /**
     * Method that should react on an error message send by an 
     * {@link IChemObjectReader}.
     *
     * @param message   Error found while reading.
     * @param exception Exception thrown while reading.
     * @param colStart Start column in the file where the error is found.
     * @param colEnd   End column in the file where the error is found.
     */
    public void handleError(String message, int row,
            int colStart, int colEnd, Exception exception);

}