Module java.base

Class StructuredTaskScope.ShutdownOnFailure

All Implemented Interfaces:
Enclosing class:

public static final class StructuredTaskScope.ShutdownOnFailure extends StructuredTaskScopePREVIEW<Object>
ShutdownOnFailure is a preview API of the Java platform.
Programs can only use ShutdownOnFailure when preview features are enabled.
Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.
A StructuredTaskScope that captures the exception of the first subtask to failPREVIEW. Once captured, it shuts downPREVIEW the task scope to interrupt unfinished threads and wakeup the task scope owner. The policy implemented by this class is intended for cases where the results for all subtasks are required ("invoke all"); if any subtask fails then the results of other unfinished subtasks are no longer needed.

Unless otherwise specified, passing a null argument to a method in this class will cause a NullPointerException to be thrown.

API Note:
This class implements a policy to shut down the task scope when a subtask fails. There shouldn't be any need to directly shut down the task scope with the shutdownPREVIEW method.