goal.tools.errorhandling.exceptions.GOALException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtime Show documentation
A system for running GOAL multi-agent systems.
The newest version!
/**
 * The GOAL Runtime Environment. Copyright (C) 2015 Koen Hindriks.
 *
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * 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 General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see .
 */
package goal.tools.errorhandling.exceptions;

import goal.tools.errorhandling.Warning;
import krTools.parser.SourceInfo;

/**
 * 
 * Generic checked exception for user error issues while running GOAL.
 * This should not be used directly as this is too vague an exception. Use more
 * specific exceptions .
 * 

 * Simple wrapper around {@link Exception}, so that generic Exceptions are no
 * longer necessary.
 * 
 * 
 * Do not add dots ('.') to the end of messages, as these will already be added
 * by {@link Warning} class
 * 
 */
public abstract class GOALException extends Exception implements Comparable {
	/** auto-generated serial version UID */
	private static final long serialVersionUID = 51927072972577978L;
	/**
	 * Around what position in the source something is located that made this
	 * exception occur.
	 */
	private SourceInfo source = null;

	public GOALException(String message) {
		super(message);
	}

	public GOALException(String message, SourceInfo source) {
		super(message);
		this.source = source;
	}

	public GOALException(String message, Throwable cause) {
		super(message, cause);
	}

	public GOALException(String message, Throwable cause, SourceInfo source) {
		super(message, cause);
		this.source = source;
	}

	/**
	 * @param builder
	 */
	protected void appendSource(StringBuilder builder) {
		if (this.source != null) {
			builder.append(" around ");
			builder.append(this.source.toString());
		}
	}

	@Override
	public int compareTo(GOALException o) {
		if (this.source == null || o.source == null) {
			return 0; // FIXME: this is equals?!
		} else {
			return this.source.compareTo(o.source);
		}
	}
}