ThreadLocalAtom

java.lang.Object
- com.bluegosling.concurrent.atoms.ThreadLocalAtom<T>

Type Parameters:

T - the type of the atom's value

All Implemented Interfaces:

Atom<T>, SynchronousAtom<T>
```
public class ThreadLocalAtom<T>
extends Object
```
An atom whose values are in thread-local storage. This varies a bit from other atoms in that one thread cannot see changes made to the atom by other threads. For that reason, the normal "watcher" behavior does not make sense. Instead, watchers of thread-local atoms will only be notified when the root value changes. The root value is the one used to seed the atom's value for new threads.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.bluegosling.concurrent.atoms.Atom
  Atom.Watcher<T>

Constructor Summary

Constructors
Constructor and Description
`ThreadLocalAtom()` Constructs a new thread-local atom with a `null` value and no validator.
`ThreadLocalAtom(T rootValue)` Constructs a new thread-local atom with the specified value and no validator.
`ThreadLocalAtom(T rootValue, Predicate<? super T> validator)` Constructs a new thread-local atom with the specified value and the specified validator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addWatcher(Atom.Watcher<? super T> watcher)` Registers a watcher, which will receive notifications when the atom's value changes.
`T`	`get()` Retrieves the current value for this atom.
`T`	`getAndUpdate(Function<? super T,? extends T> function)` Applies a function to the atom's value.
`T`	`getRootValue()` Returns the atom's root value, used to seed the thread-local value for new threads.
`Predicate<? super T>`	`getValidator()` Return the atom's validator, or `null` if there is no validator.
`protected void`	`notify(T oldValue, T newValue)` Notifies the atom's watchers that the value has changed.
`boolean`	`removeWatcher(Atom.Watcher<? super T> watcher)` Unregisters a watcher.
`T`	`set(T newValue)` Sets the atom's value to the one specified and returns the previous value.
`T`	`setRootValue(T newRootValue)` Sets the atom's root value.
`T`	`updateAndGet(Function<? super T,? extends T> function)` Applies a function to the atom's value.
`protected void`	`validate(T value)` Validates the specified value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.bluegosling.concurrent.atoms.SynchronousAtom
accumulateAndGet, getAndAccumulate

Methods inherited from interface com.bluegosling.concurrent.atoms.Atom
addWatcher, removeWatcher

- Constructor Detail
  - ThreadLocalAtom
```
public ThreadLocalAtom()
```
    Constructs a new thread-local atom with a null value and no validator.
  - ThreadLocalAtom
```
public ThreadLocalAtom(T rootValue)
```
    Constructs a new thread-local atom with the specified value and no validator.
  - ThreadLocalAtom
```
public ThreadLocalAtom(T rootValue,
                       Predicate<? super T> validator)
```
    Constructs a new thread-local atom with the specified value and the specified validator.
- Method Detail
  - get
```
public T get()
```
    Description copied from interface: Atom
    
    Retrieves the current value for this atom.
    
    Returns:
    
    the current value for the atom
  - set
```
public T set(T newValue)
```
    Description copied from interface: SynchronousAtom
    
    Sets the atom's value to the one specified and returns the previous value. Upon changing the value, watchers will be notified.
    
    Parameters:
    
    newValue - the atom's new value
    
    Returns:
    
    the atom's previous value
  - getRootValue
```
public T getRootValue()
```
    Returns the atom's root value, used to seed the thread-local value for new threads.
    
    Returns:
    
    the atom's root value
  - setRootValue
```
public T setRootValue(T newRootValue)
```
    Sets the atom's root value. Watchers will be notified of this change and passed the specified new value as well as the previous root value.
    
    Parameters:
    
    newRootValue - the new root value
    
    Returns:
    
    the previous root value
  - updateAndGet
```
public T updateAndGet(Function<? super T,? extends T> function)
```
    Description copied from interface: SynchronousAtom
    
    Applies a function to the atom's value. The atom's new value is the result of applying the specified function to the atom's current value. Watchers are notified when the value is changed.
    
    Specified by:
    
    updateAndGet in interface SynchronousAtom<T>
    
    Parameters:
    
    function - the function to apply
    
    Returns:
    
    the atom's new value
  - getAndUpdate
```
public T getAndUpdate(Function<? super T,? extends T> function)
```
    Description copied from interface: SynchronousAtom
    
    Applies a function to the atom's value. The atom's new value is the result of applying the specified function to the atom's current value. Watchers are notified when the value is changed.
    
    Specified by:
    
    getAndUpdate in interface SynchronousAtom<T>
    
    Parameters:
    
    function - the function to apply
    
    Returns:
    
    the atom's previous value
  - validate
```
protected void validate(T value)
```
    Validates the specified value. If this atom has a validator, it will be invoked and an exception is thrown if the value is not valid (e.g. the validator predicate returns false).
    
    Parameters:
    
    value - the value to validate
    
    Throws:
    
    IllegalArgumentException - if the specified value is invalid
  - getValidator
```
public Predicate<? super T> getValidator()
```
    Return the atom's validator, or null if there is no validator. The validator is a predicate that returns true when invoked on valid values for the item and false otherwise.
    
    Returns:
    
    the atom's validator
  - notify
```
protected void notify(T oldValue,
                      T newValue)
```
    Notifies the atom's watchers that the value has changed.
    
    Parameters:
    
    oldValue - the atom's old value
    
    newValue - the atom's new value
  - addWatcher
```
public boolean addWatcher(Atom.Watcher<? super T> watcher)
```
    Description copied from interface: Atom
    
    Registers a watcher, which will receive notifications when the atom's value changes.
    
    Specified by:
    
    addWatcher in interface Atom<T>
    
    Parameters:
    
    watcher - the watcher
    
    Returns:
    
    true if the watcher was registered; false if no change occurred because the watcher was already registered
  - removeWatcher
```
public boolean removeWatcher(Atom.Watcher<? super T> watcher)
```
    Description copied from interface: Atom
    
    Unregisters a watcher.
    
    Specified by:
    
    removeWatcher in interface Atom<T>
    
    Parameters:
    
    watcher - the watcher
    
    Returns:
    
    true if the watcher was unregistered; false if no change occurred because the watcher was never registered to begin with

Class ThreadLocalAtom<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.bluegosling.concurrent.atoms.Atom

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.bluegosling.concurrent.atoms.SynchronousAtom

Methods inherited from interface com.bluegosling.concurrent.atoms.Atom

Constructor Detail

ThreadLocalAtom

ThreadLocalAtom

ThreadLocalAtom

Method Detail

get

set

getRootValue

setRootValue

updateAndGet

getAndUpdate

validate

getValidator

notify

addWatcher

removeWatcher