SPIResolutionException.java

/*
 * Copyright (c) 2016, 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.spi;

/**
 * The construction and throw of this exception is embedded in code generated by
 * the JShell core implementation in such a way that, upon executing a
 * {@link jdk.jshell.Snippet.Status#RECOVERABLE_DEFINED RECOVERABLE_DEFINED}
 * user method, this exception is thrown.
 * <p>
 * This exception is seen by the execution engine, but not seen by
 * the end user nor through the JShell API.
 */
@SuppressWarnings("serial")             // serialVersionUID intentionally omitted
public class SPIResolutionException extends RuntimeException {

    private final int id;

    /**
     * Constructs an SPI layer exception indicating that a
     * {@code DeclarationSnippet} with unresolved references has been
     * encountered. The throw of this exception is generated into the body of a
     * {@link jdk.jshell.Snippet.Status#RECOVERABLE_DEFINED RECOVERABLE_DEFINED}
     * method.
     *
     * @param id An internal identifier of the specific method
     */
    public SPIResolutionException(int id) {
        super("resolution exception");
        this.id = id;
    }

    /**
     * Retrieves the internal identifier of the unresolved identifier.
     *
     * @return the internal identifier
     */
    public int id() {
        return id;
    }
}