Module jdk.incubator.concurrent
Package jdk.incubator.concurrent

Class ExtentLocal.Carrier

java.lang.Object
jdk.incubator.concurrent.ExtentLocal.Carrier
Enclosing class:
ExtentLocal<T>
public static final class ExtentLocal.Carrier extends Object
An immutable map of extent-local variables to values. It define the run and call methods to invoke an operation with the extent-local variable mappings bound to the thread that invokes run or call.
Since:
19

  • Method Details

    • where

      public <T> ExtentLocal.Carrier where(ExtentLocal<T> key, T value)
      Returns a new Carrier, which consists of the contents of this carrier plus a new mapping from key to value. If this carrier already has a mapping for the extent-local variable key then the new value added by this method overrides the previous mapping. That is to say, if there is a list of where(...) clauses, the rightmost clause wins.
      Type Parameters:
      T - the type of the ExtentLocal
      Parameters:
      key - the ExtentLocal to bind a value to
      value - the new value, can be null
      Returns:
      a new carrier, consisting of this plus a new binding (this is unchanged)

    • get

      public <T> T get(ExtentLocal<T> key)
      Returns the value of a variable in this map of extent-local variables.
      Type Parameters:
      T - the type of the ExtentLocal
      Parameters:
      key - the ExtentLocal variable
      Returns:
      the value
      Throws:
      NoSuchElementException - if key is not bound to any value

    • call

      public <R> R call(Callable<R> op) throws Exception
      Runs a value-returning operation with this map of extent-local variables bound to values. Code invoked by op can use the get method to get the value of the extent local. The extent-local variables revert to their previous values or become unbound when the operation completes.

      Extent-local variables are intended to be used in a structured manner. If op creates any StructuredTaskScopes but does not close them, then exiting op causes the underlying construct of each StructuredTaskScope to be closed (in the reverse order that they were created in), and StructureViolationException to be thrown.

      Type Parameters:
      R - the type of the result of the function
      Parameters:
      op - the operation to run
      Returns:
      the result
      Throws:
      Exception - if op completes with an exception

    • run

      public void run(Runnable op)
      Runs an operation with this map of ExtentLocals bound to values. Code executed by the operation can use the get() method to get the value of the extent local. The extent-local variables revert to their previous values or becomes unbound when the operation completes.

      Extent-local variables are intended to be used in a structured manner. If op creates any StructuredTaskScopes but does not close them, then exiting op causes the underlying construct of each StructuredTaskScope to be closed (in the reverse order that they were created in), and StructureViolationException to be thrown.

      Parameters:
      op - the operation to run