Interface StructuredTaskScope.Configuration

Enclosing interface:

StructuredTaskScope<T, R, R_X extends Throwable>

public static sealed interface StructuredTaskScope.Configuration

Represents the configuration for a StructuredTaskScope.

The configuration for a StructuredTaskScope consists of a ThreadFactory to create threads, an optional name for the scope, and an optional timeout. The name is intended for monitoring and management purposes.

Creating a StructuredTaskScope with the open(UnaryOperator) or open(Joiner, UnaryOperator) method allows a different configuration to be used. The operator specified to the open method is applied to the default configuration and returns the configuration for the StructuredTaskScope under construction. The operator can use the with- prefixed methods defined here to specify the components of the configuration to use.

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

Since:

28

Method Summary

Modifier and Type	Method	Description
StructuredTaskScope.Configuration	withName(String name)	Returns a new Configuration object with the given scope name.
StructuredTaskScope.Configuration	withThreadFactory(ThreadFactory threadFactory)	Returns a new Configuration object with the given thread factory.
StructuredTaskScope.Configuration	withTimeout(Duration timeout)	Returns a new Configuration object with the given timeout.

Method Details

withThreadFactory

StructuredTaskScope.Configuration withThreadFactory(ThreadFactory threadFactory)

Returns a new Configuration object with the given thread factory. The other components are the same as this object. The thread factory is used by a scope to create threads when forking subtasks.

API Note:

The thread factory will typically create virtual threads, maybe with thread names for monitoring purposes, an uncaught exception handler, or other properties configured.

Parameters:

threadFactory - the thread factory

Returns:

a new Configuration object with the given thread factory

See Also:

• StructuredTaskScope.fork(Callable)

withName

StructuredTaskScope.Configuration withName(String name)

Returns a new Configuration object with the given scope name. The other components are the same as this object. A scope is optionally named for the purposes of monitoring and management.

Parameters:

name - the name

Returns:

a new Configuration object with the given scope name

withTimeout

StructuredTaskScope.Configuration withTimeout(Duration timeout)

Returns a new Configuration object with the given timeout. The other components are the same as this object.

API Note:

Applications using deadlines, expressed as an Instant, can use Duration.between(Instant.now(), deadline) to compute the timeout for this method.

Parameters:

timeout - the timeout

Returns:

a new Configuration object with the given timeout

See Also:

• StructuredTaskScope.join()
• StructuredTaskScope.CancelledByTimeoutException