fr.boreal.io.api.ParseException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of integraal-io Show documentation
Inputs and Outputs for integraal objects
The newest version!
/*
 * Copyright (C) Inria Sophia Antipolis - Méditerranée / LIRMM
 * (Université de Montpellier & CNRS) (2014 - 2017)
 *
 * Contributors :
 *
 * Clément SIPIETER 
 * Mélanie KÖNIG
 * Swan ROCHER
 * Jean-François BAGET
 * Michel LECLÈRE
 * Marie-Laure MUGNIER 
 *
 *
 * This file is part of Graal .
 *
 * This software is governed by the CeCILL  license under French law and
 * abiding by the rules of distribution of free software.  You can  use,
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
 */

package fr.boreal.io.api;

import fr.lirmm.boreal.util.stream.IteratorException;

import java.io.Serial;

/**
 * This class describes exceptions that occurred during the parsing
 * 
 * @author Clément Sipieter (INRIA) <[email protected]>
 *
 */
public class ParseException extends IteratorException {

	@Serial
	private static final long serialVersionUID = -4455111019098315998L;
	
	/**
	 * Line number at which the exception was detected.
	 * 

	 * Default (unknown) is -1
	 */
	private int line = -1;
	
	/**
	 * Character position in the line at which the exception was detected.
	 * 

	 * Default (unknown) is -1
	 */
	private int column = -1;
	
	/**
	 * @param message the message of the exception
	 * @param e the initial exception
	 */
	public ParseException(String message, Throwable e) {
		super(message, e);
	}

	/**
	 * @param message the message of the exception
	 */
	public ParseException(String message) {
		super(message);
	}
	
	/**
	 * @param message the message of the exception
	 * @param line the line at which the exception was detected
	 * @param column the character position in the line at which the exception was detected
	 */
	public ParseException(String message, int line, int column) {
		super((line >= 0 && column >= 0)?"line " + line + " column " + column + ": " + message:message);
		this.line = line;
		this.column = column;
	}

	/**
	 * @param e the initial exception
	 */
	public ParseException(Throwable e) {
		super(e);
	}
	
	
	/**
	 * @return the line at which the exception occurred, -1 if it is not known
	 */
	public int getLine() {
		return line;
	}
	
	/**
	 * @return the character position in the line at which the exception was detected, -1 if it is not known
	 */
	public int getColumn() {
		return column;
	}

}