/*
 * Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.api.interop;

import com.oracle.truffle.api.CompilerDirectives;
import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;

Common super class for exceptions that can occur when sending interop
messages. This super class is used to catch any kind of these exceptions. 
See Also:
InteropLibrary
Since:
0.11/**
 * Common super class for exceptions that can occur when sending {@link InteropLibrary interop
 * messages}. This super class is used to catch any kind of these exceptions.
 *
 * @see InteropLibrary
 * @since 0.11
 */
public abstract class InteropException extends Exception {

    InteropException(String message, Throwable cause) {
        super(message, cause);
        validateTruffleException(cause);
    }

    InteropException(String message) {
        super(message);
    }

    
Returns the cause of an interop exception.
{@inheritDoc}
Since:
20.2/**
     * Returns the cause of an interop exception.
     *
     * {@inheritDoc}
     *
     * @since 20.2
     */
    @Override
    @TruffleBoundary
    // GR-23961 - after language adoption we should make this non-synchronized as initCause is not
    // longer used
    public final synchronized Throwable getCause() {
        return super.getCause();
    }

    
Initializes the casue for an interop exception. Will no longer be supported as of 20.3. Pass
in the cause using the interop constructors instead.
Deprecated:
Do no longer use the cause will be initialized finally.
Since:
20.2/**
     * Initializes the casue for an interop exception. Will no longer be supported as of 20.3. Pass
     * in the cause using the interop constructors instead.
     *
     * @deprecated Do no longer use the cause will be initialized finally.
     * @since 20.2
     */
    @Override
    @Deprecated
    @TruffleBoundary
    public final synchronized Throwable initCause(Throwable cause) {
        return super.initCause(cause);
    }

    
No stack trace for interop exceptions.
Since:
20.2/**
     * No stack trace for interop exceptions.
     *
     * @since 20.2
     */
    @SuppressWarnings("sync-override")
    @Override
    public final Throwable fillInStackTrace() {
        return this;
    }

    @SuppressWarnings("deprecation")
    private static void validateTruffleException(Throwable t) {
        if (CompilerDirectives.inCompiledCode()) {
            return;
        }
        if (t == null) {
            return;
        }
        if (!(t instanceof com.oracle.truffle.api.TruffleException)) {
            throw new IllegalArgumentException("Cause exception must implement TruffleException but was " + t.getClass() + ".");
        }
    }

    private static final long serialVersionUID = -5173354806966156285L;
}