W3cubDocs

/OpenJDK 21

Class FailOverExecutionControlProvider

java.lang.Object
jdk.jshell.execution.FailOverExecutionControlProvider
All Implemented Interfaces:
ExecutionControlProvider
public class FailOverExecutionControlProvider extends Object implements ExecutionControlProvider
Tries other providers in sequence until one works.
Since:
9

Constructor Summary

Constructor Description
FailOverExecutionControlProvider()
Create an instance.

Method Summary

Modifier and Type Method Description
Map<String,String> defaultParameters()
Create and return the default parameter map for this ExecutionControlProvider.
ExecutionControl generate(ExecutionEnv env, Map<String,String> parameters)
Create and return a locally executing ExecutionControl instance.
String name()
The unique name of this ExecutionControlProvider.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FailOverExecutionControlProvider

public FailOverExecutionControlProvider()
Create an instance. The instance can be used to start and return an ExecutionControl instance by attempting to start a series of ExecutionControl specs, until one is successful.
See Also:

Method Details

name

public String name()
The unique name of this ExecutionControlProvider.
Specified by:
name in interface ExecutionControlProvider
Returns:
"failover"

defaultParameters

public Map<String,String> defaultParameters()
Create and return the default parameter map for this ExecutionControlProvider. There are ten parameters, "0" through "9", their values are ExecutionControlProvider specification strings, or empty string.
Specified by:
defaultParameters in interface ExecutionControlProvider
Returns:
a default parameter map

generate

public ExecutionControl generate(ExecutionEnv env, Map<String,String> parameters) throws Throwable
Create and return a locally executing ExecutionControl instance. At least one parameter should have a spec.
Specified by:
generate in interface ExecutionControlProvider
Parameters:
env - the execution environment, provided by JShell
parameters - the modified parameter map.
Returns:
the execution engine
Throws:
Throwable - if all the given providers fail, the exception that occurred on the first attempt to create the execution engine.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.jshell/jdk/jshell/execution/FailOverExecutionControlProvider.html