1 /*

     2  * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 

    26 package jdk.jshell.spi;

    27 

    28 /**

    29  * The construction and throw of this exception is embedded in code generated by

    30  * the JShell core implementation in such a way that, upon executing a

    31  * {@link jdk.jshell.Snippet.Status#RECOVERABLE_DEFINED RECOVERABLE_DEFINED}

    32  * user method, this exception is thrown.

    33  * <p>

    34  * This exception is seen by the execution engine, but not seen by

    35  * the end user nor through the JShell API.

    36  *

    37  * @see ExecutionEnv#createUnresolvedReferenceException(int,

    38  * java.lang.StackTraceElement[])

    39  */

    40 @SuppressWarnings("serial")             // serialVersionUID intentionally omitted

    41 public class SPIResolutionException extends RuntimeException {

    42 

    43     private final int id;

    44 

    45     /**

    46      * Constructs an SPI layer exception indicating that a

    47      * {@code DeclarationSnippet} with unresolved references has been

    48      * encountered. The throw of this exception is generated into the body of a

    49      * {@link jdk.jshell.Snippet.Status#RECOVERABLE_DEFINED RECOVERABLE_DEFINED}

    50      * method.

    51      *

    52      * @param id An internal identifier of the specific method

    53      */

    54     public SPIResolutionException(int id) {

    55         super("resolution exception");

    56         this.id = id;

    57     }

    58 

    59     /**

    60      * Retrieves the internal identifer of the unresolved identifer.

    61      *

    62      * @return the internal identifer

    63      * @see ExecutionEnv#createUnresolvedReferenceException(int,

    64      * java.lang.StackTraceElement[])

    65      */

    66     public int id() {

    67         return id;

    68     }

    69 }