/*
 * Bytecode Analysis Framework
 * Copyright (C) 2005, 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.InstructionHandle;
import org.apache.bcel.generic.MethodGen;

/**
 * An exception that may be thrown by frame modeling visitor classes to indicate
 * that the method being analyzed contains invalid bytecode. For example, this
 * can be thrown to indicate that a method invocation requires more stack
 * operands than are available. AbstractFrameModelingVisitor will catch this
 * exception and rethrow it as a checked DataflowAnalysisException.
 * 
 * @author David Hovemeyer
 */
public class InvalidBytecodeException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    /**
     * Constructor.
     * 
     * @param msg
     *            reason for the exception
     */
    public InvalidBytecodeException(String msg) {
        super(msg);
    }

    /**
     * Constructor.
     * 
     * @param msg
     *            reason for the exception
     * @param cause
     *            another exception that is the cause of this exception
     */
    public InvalidBytecodeException(String msg, Throwable cause) {
        super(msg, cause);
    }

    /**
     * Constructor from method and instruction.
     * 
     * @param message
     *            reason for the error
     * @param methodGen
     *            the method
     * @param handle
     *            the instruction
     */
    public InvalidBytecodeException(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 handle
     *            the instruction
     * @param cause
     *            another exception that is the cause of this exception
     */
    public InvalidBytecodeException(String message, MethodGen methodGen, InstructionHandle handle, Throwable cause) {
        super(message + " in " + SignatureConverter.convertMethodSignature(methodGen) + " at " + handle, cause);
    }
}
