com.diffplug.common.rx

Interface CasBox<T>

All Superinterfaces:

Box<T>, Consumer<T>, Supplier<T>

All Known Implementing Classes:

ForwardingBox.Cas

public interface CasBox<T>
extends Box<T>

CasBox is a lock-free and race-condition-free mechanism for updating a value. Its API and implementation is taken straight from [Clojure's Atom](http://clojure.org/reference/atoms) concept. Many thanks to Rich Hickey for his excellent work.

Nested Class Summary

Nested classes/interfaces inherited from interface com.diffplug.common.base.Box

Box.Dbl, Box.Int, Box.Lng, Box.Nullable<T>

Method Summary

Modifier and Type	Method and Description
boolean	compareAndSet(T expect, T update) The compare and set method which this box is capable of using.
T	getAndSet(T newValue) Gets the current value, and sets it with a new one.
default <R> CasBox<R>	map(Converter<T,R> converter)
default T	modify(Function<? super T,? extends T> mutator) Applies the given mutator function to this box, which may require calling the function more than once, so make sure it's pure! The function is called using the box's current input, and compareAndSet is used to ensure that the input does not change.
static <T> CasBox<T>	of(T value) Returns a CasBox around the given value.

Methods inherited from interface com.diffplug.common.base.Box

accept, from, ofVolatile, set

Methods inherited from interface java.util.function.Supplier

get

Methods inherited from interface java.util.function.Consumer

andThen

Method Detail

compareAndSet

boolean compareAndSet(T expect,
                      T update)

The compare and set method which this box is capable of using.

getAndSet

T getAndSet(T newValue)

Gets the current value, and sets it with a new one.

modify

default T modify(Function<? super T,? extends T> mutator)

Applies the given mutator function to this box, which may require calling the function more than once, so make sure it's pure! The function is called using the box's current input, and compareAndSet is used to ensure that the input does not change. The implementation is more or less verbatim from Rich Hickey's [Clojure](https://github.com/clojure/clojure/blob/bfb82f86631bde45a8e3749ea7df509e59a0791c/src/jvm/clojure/lang/Atom.java#L75-L87).

Specified by:

modify in interface Box<T>

of

static <T> CasBox<T> of(T value)

Returns a CasBox around the given value.

Specified by:

of in interface Box<T>

map

default <R> CasBox<R> map(Converter<T,R> converter)

Specified by:

map in interface Box<T>