/*
    JPC: An x86 PC Hardware Emulator for a pure Java Virtual Machine
    Release Version 2.4

    A project from the Physics Dept, The University of Oxford

    Copyright (C) 2007-2010 The University of Oxford

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2 as published by
    the Free Software Foundation.

    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, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
    Details (including contact information) can be found at: 

    jpc.sourceforge.net
    or the developer website
    sourceforge.net/projects/jpc/

    Conceived and Developed by:
    Rhys Newman, Ian Preston, Chris Dennis

    End of licence header
*/

package org.jpc.emulator.execution.codeblock;

/**
 * Thrown by a codeblock on execution to indicate it requires replacement.
 * @author Chris Dennis
 */
public class CodeBlockReplacementException extends RuntimeException
{
    private CodeBlock replacement;

    /**
     * Constructs an exception which requests the throwing block be replaced
     * with the supplied block.
     * <p>
     * This is used by the codeblock compilers to inject a faster replacement
     * block.
     * @param replacement new block to be inserted.
     */
    public CodeBlockReplacementException(CodeBlock replacement)
    {
        super("CodeBlock Replacement Trigger Exception");
        this.replacement = replacement;
    }

    /**
     * Gets the new block instance.
     * @return new block.
     */
    public CodeBlock getReplacement()
    {
        return replacement;
    }
}
