/*
 * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.oracle.truffle.api.nodes;

/**
 * An exception that should be thrown if the return value cannot be represented as a value of the
 * return type. The Truffle optimizer has special knowledge of this exception class and will never
 * compile a catch block that catches this exception type.
 */
public final class UnexpectedResultException extends SlowPathException {

    private static final long serialVersionUID = 3676602078425211386L;
    private final Object result;

    /**
     * Creates the exception with the alternative result that cannot be respresented as a value of
     * the return type.
     * 
     * @param result the alternative result
     */
    public UnexpectedResultException(Object result) {
        super(null, null);
        assert !(result instanceof Throwable);
        this.result = result;
    }

    /**
     * @return the unexpected result
     */
    public Object getResult() {
        return result;
    }

    /**
     * For performance reasons, this exception does not record any stack trace information.
     */
    @Override
    public synchronized Throwable fillInStackTrace() {
        return null;
    }
}