Class StructuredTaskScope.ShutdownOnSuccess<T>

Type Parameters:
T - the result type
All Implemented Interfaces:
Enclosing class:

public static final class StructuredTaskScope.ShutdownOnSuccess<T> extends StructuredTaskScopePREVIEW<T>
ShutdownOnSuccess is a preview API of the Java platform.
Programs can only use ShutdownOnSuccess 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 result of the first subtask to complete successfullyPREVIEW. 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 result of any subtask will do ("invoke any") and where 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 completes successfully. There shouldn't be any need to directly shut down the task scope with the shutdownPREVIEW method.
  • Constructor Details

    • ShutdownOnSuccess

      public ShutdownOnSuccess(String name, ThreadFactory factory)
      Constructs a new ShutdownOnSuccess with the given name and thread factory. The task scope is optionally named for the purposes of monitoring and management. The thread factory is used to create threads when subtasks are forkedPREVIEW. The task scope is owned by the current thread.

      Construction captures the current thread's scoped valuePREVIEW bindings for inheritance by threads started in the task scope. The Tree Structure section in the class description details how parent-child relations are established implicitly for the purpose of inheritance of scoped value bindings.

      name - the name of the task scope, can be null
      factory - the thread factory
    • ShutdownOnSuccess

      public ShutdownOnSuccess()
      Constructs a new unnamed ShutdownOnSuccess that creates virtual threads.
      Implementation Requirements:
      This constructor is equivalent to invoking the 2-arg constructor with a name of null and a thread factory that creates virtual threads.
  • Method Details