gololang

Class DynamicVariable

java.lang.Object

gololang.DynamicVariable

public final class DynamicVariable
extends java.lang.Object

A dynamic variable has the semantics of an inheritable thread-local reference. This class is modeled after the eponymous class from the Scala standard library.

See Also:

InheritableThreadLocal

Constructor Summary

Constructors

Constructor and Description
DynamicVariable(java.lang.Object init) Creates a new dynamic variable with an initial value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
java.lang.Object	value() Returns the thread-local value of the dynamic variable.
DynamicVariable	value(java.lang.Object value) Changes the dynamic variable value.
java.lang.Object	withValue(java.lang.Object value, FunctionReference func) Given a value, calls a function func.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DynamicVariable

public DynamicVariable(java.lang.Object init)

Creates a new dynamic variable with an initial value.

Parameters:

init - the initial value.

Method Detail

value

public java.lang.Object value()

Returns the thread-local value of the dynamic variable.

Returns:

the value.

value

public DynamicVariable value(java.lang.Object value)

Changes the dynamic variable value. The new value is only visible from the calling thread, and will be seen by future child threads.

Parameters:

value - the new thread-local value.

Returns:

this dynamic variable.

withValue

public java.lang.Object withValue(java.lang.Object value,
                                  FunctionReference func)
                           throws java.lang.Throwable

Given a value, calls a function func. The previous value is put pack as the dynamic variable value once func has completed.

Parameters:

value - the value for the course of the execution of func.

func - a 0-arity function.

Returns:

the result of the call to func.

Throws:

java.lang.Throwable - in case an exception occurs.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object