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/** 27 * Defines the Service Provider Interface for pluggable JShell execution engines. 28 * The JShell core tracks and compiles Snippets then sends them 29 * (represented in a wrapper class) to the execution engine for loading, 30 * and in the case of executable Snippets, execution. The JShell 31 * implementation includes a default execution engine (currently a remote 32 * process which is JDI controlled). By implementing the 33 * {@link jdk.jshell.spi.ExecutionControl} interface and its generating class, 34 * an implementation of the {@link jdk.jshell.spi.ExecutionControlProvider} 35 * interface, and installing it with 36 * {@link jdk.jshell.JShell.Builder#executionEngine(String)} 37 * other execution engines can be used. Where the passed String is an 38 * {@code ExecutionControl} spec. 39 * <p> 40 * The {@code ExecutionControl} spec is the {@code ExecutionControlProvider} 41 * name optionally followed by a parameter specification. 42 * The syntax of the spec is: 43 * <pre> 44 * spec := name : params 45 * | name 46 * name := identifier 47 * params := param , params 48 * | param 49 * | 50 * param := identifier ( value ) 51 * </pre> 52 * Where 'name' is the {@code ExecutionControlProvider} 53 * {@linkplain ExecutionControlProvider#name() name}. 54 * Where 'param' is a Map key from 55 * {@link ExecutionControlProvider#defaultParameters()} and the parenthesized 56 * value; See, for example, 57 * {@link jdk.jshell.execution.JdiExecutionControlProvider}. 58 * Where 'identifier' is a sequence of 59 * {@linkplain java.lang.Character#isJavaIdentifierPart(char) 60 * Java identifier part characters} from the Basic Multilingual Plane. 61 * <p> 62 * For example: 63 * <ul> 64 * <li>local</li> 65 * <li>jdi:hostname(localhost)</li> 66 * <li>failover:1(jdi),2(jdi:launch(true),timeout(3000)),3(local)</li> 67 * </ul> 68 * 69 * @since 9 70 * @see jdk.jshell.execution for execution implementation support 71 */ 72package jdk.jshell.spi; 73