Class StructuredTaskScope.ShutdownOnFailure
- All Implemented Interfaces:
- AutoCloseable
- Enclosing class:
- StructuredTaskScopePREVIEW<T>
ShutdownOnFailure is a preview API of the Java platform.
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.
- 
Nested Class SummaryNested classes/interfaces declared in class java.util.concurrent.StructuredTaskScopePREVIEWStructuredTaskScope.ShutdownOnFailurePREVIEW, StructuredTaskScope.ShutdownOnSuccessPREVIEW<T>, StructuredTaskScope.SubtaskPREVIEW<T>
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new unnamedShutdownOnFailurethat creates virtual threads.ShutdownOnFailure(String name, ThreadFactory factory) Constructs a newShutdownOnFailurewith the given name and thread factory.
- 
Method SummaryModifier and TypeMethodDescriptionjoin()void<X extends Throwable>
 voidthrowIfFailed(Function<Throwable, ? extends X> esf) Methods declared in class java.util.concurrent.StructuredTaskScopePREVIEWclose, ensureOwnerAndJoined, fork, handleComplete, isShutdown, shutdown
- 
Constructor Details- 
ShutdownOnFailureConstructs a newShutdownOnFailurewith the given name and thread factory. The task scope is optionally named for the purposes of monitoring and management. The thread factory is used tocreatethreads when subtasks are forkedPREVIEW. The task scope is owned by the current thread.Construction captures the current thread's scoped value 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. - Parameters:
- name- the name of the task scope, can be null
- factory- the thread factory
 
- 
ShutdownOnFailurepublic ShutdownOnFailure()Constructs a new unnamedShutdownOnFailurethat creates virtual threads.- Implementation Requirements:
- This constructor is equivalent to invoking the 2-arg constructor with
 a name of nulland a thread factory that creates virtual threads.
 
 
- 
- 
Method Details- 
joinWait for all subtasks started in this task scope to complete or for a subtask to failPREVIEW.This method waits for all subtasks by waiting for all threads startedPREVIEW in this task scope to finish execution. It stops waiting when all threads finish, a subtask fails, or the current thread is interrupted. It also stops waiting if the shutdownPREVIEW method is invoked directly to shut down this task scope.This method may only be invoked by the task scope owner. - Overrides:
- joinin class- StructuredTaskScopePREVIEW<Object>
- Returns:
- this task scope
- Throws:
- IllegalStateException- if this task scope is closed
- WrongThreadException- if the current thread is not the task scope owner
- InterruptedException- if interrupted while waiting
 
- 
joinUntilpublic StructuredTaskScope.ShutdownOnFailurePREVIEW joinUntil(Instant deadline) throws InterruptedException, TimeoutException Wait for all subtasks started in this task scope to complete or for a subtask to failPREVIEW, up to the given deadline.This method waits for all subtasks by waiting for all threads startedPREVIEW in this task scope to finish execution. It stops waiting when all threads finish, a subtask fails, the deadline is reached, or the current thread is interrupted. It also stops waiting if the shutdownPREVIEW method is invoked directly to shut down this task scope.This method may only be invoked by the task scope owner. - Overrides:
- joinUntilin class- StructuredTaskScopePREVIEW<Object>
- Parameters:
- deadline- the deadline
- Returns:
- this task scope
- Throws:
- IllegalStateException- if this task scope is closed
- WrongThreadException- if the current thread is not the task scope owner
- InterruptedException- if interrupted while waiting
- TimeoutException- if the deadline is reached while waiting
 
- 
exceptionReturns the exception of the first subtask that failedPREVIEW. If no subtasks failed then an emptyOptionalis returned.- Returns:
- the exception for the first subtask to fail or an empty optional if no subtasks failed
- Throws:
- WrongThreadException- if the current thread is not the task scope owner
- IllegalStateException- if the task scope owner did not join after forking
 
- 
throwIfFailedThrows if a subtask failedPREVIEW. If any subtask failed with an exception thenExecutionExceptionis thrown with the exception of the first subtask to fail as the cause. This method does nothing if no subtasks failed.- Throws:
- ExecutionException- if a subtask failed
- WrongThreadException- if the current thread is not the task scope owner
- IllegalStateException- if the task scope owner did not join after forking
 
- 
throwIfFailedThrows the exception produced by the given exception supplying function if a subtask failedPREVIEW. If any subtask failed with an exception then the function is invoked with the exception of the first subtask to fail. The exception returned by the function is thrown. This method does nothing if no subtasks failed.- Type Parameters:
- X- type of the exception to be thrown
- Parameters:
- esf- the exception supplying function
- Throws:
- X- produced by the exception supplying function
- WrongThreadException- if the current thread is not the task scope owner
- IllegalStateException- if the task scope owner did not join after forking
 
 
- 
ShutdownOnFailurewhen preview features are enabled.