/*
 * Bytecode Analysis Framework
 * Copyright (C) 2003,2004 University of Maryland
 *
 * This library 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.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs.ba;

import org.apache.bcel.generic.Instruction;
import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.MethodGen;

import edu.umd.cs.findbugs.classfile.UncheckedAnalysisException;

/**
 * A kind of runtime exception that can be thrown to indicate a fatal error in
 * an analysis. It would be nice to make this a checked exception, but we can't
 * throw those from BCEL visitors.
 */
public class AnalysisException extends UncheckedAnalysisException {
    /**
     *
     */
    private static final long serialVersionUID = 1L;

    /**
     * Constructor.
     *
     * @param message
     *            reason for the error
     */
    public AnalysisException(String message) {
        super(message);
    }

    /**
     * Constructor from another Throwable object. This is useful for chaining
     * exceptions.
     *
     * @param message
     *            reason for the error
     * @param throwable
     *            cause of the error
     */
    public AnalysisException(String message, Throwable throwable) {
        super(message, throwable);
    }

    /**
     * Constructor from MethodGen and another Throwable object. This is useful
     * for chaining exceptions.
     *
     * @param message
     *            reason for the error
     * @param methodGen
     *            the method
     * @param throwable
     *            cause of the error
     */
    public AnalysisException(String message, MethodGen methodGen, Throwable throwable) {
        super(message + " in " + SignatureConverter.convertMethodSignature(methodGen), throwable);
    }

    /**
     * Constructor from method and instruction.
     *
     * @param message
     *            reason for the error
     * @param methodGen
     *            the method
     * @param handle
     *            the instruction
     */
    public AnalysisException(String message, MethodGen methodGen, InstructionHandle handle) {
        super(message + " in " + SignatureConverter.convertMethodSignature(methodGen) + " at " + handle);
    }

    /**
     * Constructor from method and instruction.
     *
     * @param message
     *            reason for the error
     * @param methodGen
     *            the method
     * @param ins
     *            the instruction
     */
    public AnalysisException(String message, MethodGen methodGen, Instruction ins) {
        super(message + " in " + SignatureConverter.convertMethodSignature(methodGen) + " at " + ins);
    }

    /**
     * Constructor from method, instruction, and causing Throwable object.
     *
     * @param message
     *            reason for the error
     * @param methodGen
     *            the method
     * @param handle
     *            the instruction
     * @param throwable
     *            the cause of the error
     */
    public AnalysisException(String message, MethodGen methodGen, InstructionHandle handle, Throwable throwable) {
        super(message + " in " + SignatureConverter.convertMethodSignature(methodGen) + " at " + handle, throwable);
    }

    /**
     * Constructor from method, instruction, and causing Throwable object.
     *
     * @param message
     *            reason for the error
     * @param methodGen
     *            the method
     * @param ins
     *            the instruction
     * @param throwable
     *            the cause of the error
     */
    public AnalysisException(String message, MethodGen methodGen, Instruction ins, Throwable throwable) {
        super(message + " in " + SignatureConverter.convertMethodSignature(methodGen) + " at " + ins, throwable);
    }
}

