/*
 * Copyright (c) 2015, 2018, 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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 jdk.jshell;

Wraps an throwable thrown in the executing client.
An instance of EvalException can be returned in the SnippetEvent.exception() query. The name of the throwable thrown is available from getExceptionClassName(). Message and stack can be queried by methods on Exception.

Note that in stack trace frames representing JShell Snippets,
StackTraceElement.getFileName() will return "#" followed by
the Snippet id and for snippets without a method name (for example an
expression) StackTraceElement.getMethodName() will be the
empty string.
Since:
9/**
 * Wraps an throwable thrown in the executing client.
 * An instance of <code>EvalException</code> can be returned in the
 * {@link jdk.jshell.SnippetEvent#exception()} query.
 * The name of the throwable thrown is available from
 * {@link jdk.jshell.EvalException#getExceptionClassName()}.
 * Message and stack can be queried by methods on <code>Exception</code>.
 * <p>
 * Note that in stack trace frames representing JShell Snippets,
 * <code>StackTraceElement.getFileName()</code> will return "#" followed by
 * the Snippet id and for snippets without a method name (for example an
 * expression) <code>StackTraceElement.getMethodName()</code> will be the
 * empty string.
 *
 * @since 9
 */
@SuppressWarnings("serial")             // serialVersionUID intentionally omitted
public class EvalException extends JShellException {
    private final String exceptionClass;

    EvalException(String message, String exceptionClass,
            StackTraceElement[] stackElements, JShellException cause) {
        super(message, cause);
        this.exceptionClass = exceptionClass;
        this.setStackTrace(stackElements);
    }

    
Returns the name of the Throwable subclass which was thrown in the executing client. Note this class may not be loaded in the controlling process. See Class.getName() for the format of the string. 
Returns:
the name of the exception class as a String/**
     * Returns the name of the Throwable subclass which was thrown in the
     * executing client. Note this class may not be loaded in the controlling
     * process.
     * See
     * {@link java.lang.Class#getName() Class.getName()} for the format of the string.
     * @return the name of the exception class as a String
     */
    public String getExceptionClassName() {
        return exceptionClass;
    }

    
Returns the wrapped cause of the throwable in the executing client represented by this EvalException or null if the cause is nonexistent or unknown. 
Returns:
the cause wrapped in a EvalException or UnresolvedReferenceException or return null if the cause is nonexistent or unknown.
Since:
11/**
     * Returns the wrapped cause of the throwable in the executing client
     * represented by this {@code EvalException} or {@code null} if the cause is
     * nonexistent or unknown.
     *
     * @return the cause wrapped in a {@code EvalException} or
     * {@link UnresolvedReferenceException} or return {@code null} if the cause
     * is nonexistent or unknown.
     * @since 11
     */
    @Override
    public JShellException getCause() {
        return (JShellException) super.getCause();
    }
}