hu.akarnokd.rxjava2.internal.util

Enum TerminalAtomicsHelper

java.lang.Object

java.lang.Enum<TerminalAtomicsHelper>

hu.akarnokd.rxjava2.internal.util.TerminalAtomicsHelper

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TerminalAtomicsHelper>

public enum TerminalAtomicsHelper
extends java.lang.Enum<TerminalAtomicsHelper>

Helper class to handle copy-on-write arrays plus terminal state for arbitrary references.

Method Summary

Modifier and Type	Method and Description
static <U> boolean	add(java.util.concurrent.atomic.AtomicReference<U[]> instance, U newValue, U[] terminalValue, IntFunction<U[]> arraySupplier) Atomically replaces the array in instance with a new array that contains the newValue as well or returns false if the instance holds the terminalValue.
static <T,U> boolean	add(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U[]> updater, T instance, U newValue, U[] terminalValue, IntFunction<U[]> arraySupplier) Atomically replaces the array in instance with a new array that contains the newValue as well or returns false if the instance holds the terminalValue.
static <U> boolean	remove(java.util.concurrent.atomic.AtomicReference<U[]> reference, U value, U[] terminalValue, U[] zeroArray, IntFunction<U[]> arraySupplier) Atomically replaces the array in instance with a new array that doesn't contain the given value or returns false if the instance holds the terminal state or an empty array or the value is not in the array.
static <T,U> boolean	remove(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U[]> updater, T instance, U value, U[] terminalValue, U[] zeroArray, IntFunction<U[]> arraySupplier) Atomically replaces the array in instance with a new array that doesn't contain the given value or returns false if the instance holds the terminal state or an empty array or the value is not in the array.
static <T,U> boolean	set(java.util.concurrent.atomic.AtomicReference<U> instance, U newValue, U terminalValue, Consumer<? super U> onTerminate) Atomically replaces the contents of the instance and calls the callback with the old value or calls the callback with the new value if the instance holds the terminal value.
static <T,U> boolean	set(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater, T instance, U newValue, U terminalValue, Consumer<? super U> onTerminate) Atomically replaces the contents of the instance and calls the callback with the old value or calls the callback with the new value if the instance holds the terminal value.
static <U> U	terminate(java.util.concurrent.atomic.AtomicReference<U> instance, U terminalValue) Atomically swaps in the terminal value and returns the previous value.
static <U> void	terminate(java.util.concurrent.atomic.AtomicReference<U> instance, U terminalValue, Consumer<? super U> onTerminate) Atomically swaps in the terminalValue and calls the given callback if not already terminated.
static <T,U> U	terminate(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater, T instance, U terminalValue) Atomically swaps in the terminal value and returns the previous value.
static <T,U> void	terminate(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater, T instance, U terminalValue, Consumer<? super U> onTerminate) Atomically swaps in the terminalValue and calls the given callback if not already terminated.
static <T,U> boolean	update(java.util.concurrent.atomic.AtomicReference<U> instance, U newValue, U terminalValue, Consumer<? super U> onTerminate) Atomically replaces the content of the instance but calls the callback only if the instance holds the terminal value.
static <T,U> boolean	update(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater, T instance, U newValue, U terminalValue, Consumer<? super U> onTerminate) Atomically replaces the content of the instance but calls the callback only if the instance holds the terminal value.
static TerminalAtomicsHelper	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TerminalAtomicsHelper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static TerminalAtomicsHelper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TerminalAtomicsHelper c : TerminalAtomicsHelper.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TerminalAtomicsHelper valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

terminate

public static <T,U> void terminate(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater,
                                   T instance,
                                   U terminalValue,
                                   Consumer<? super U> onTerminate)

Atomically swaps in the terminalValue and calls the given callback if not already terminated.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

updater -

instance -

terminalValue -

onTerminate -

terminate

public static <U> void terminate(java.util.concurrent.atomic.AtomicReference<U> instance,
                                 U terminalValue,
                                 Consumer<? super U> onTerminate)

Atomically swaps in the terminalValue and calls the given callback if not already terminated.

Type Parameters:

U - the reference type

Parameters:

instance -

terminalValue -

onTerminate -

terminate

public static <T,U> U terminate(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater,
                                T instance,
                                U terminalValue)

Atomically swaps in the terminal value and returns the previous value.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

updater -

instance -

terminalValue -

Returns:

the last value or the terminal value

terminate

public static <U> U terminate(java.util.concurrent.atomic.AtomicReference<U> instance,
                              U terminalValue)

Atomically swaps in the terminal value and returns the previous value.

Type Parameters:

U - the reference type

Parameters:

instance -

terminalValue -

Returns:

the last value or the terminal value

set

public static <T,U> boolean set(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater,
                                T instance,
                                U newValue,
                                U terminalValue,
                                Consumer<? super U> onTerminate)

Atomically replaces the contents of the instance and calls the callback with the old value or calls the callback with the new value if the instance holds the terminal value.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

updater -

instance -

newValue -

terminalValue -

onTerminate -

Returns:

false if the instance holds the terminal value

See Also:

update(AtomicReferenceFieldUpdater, Object, Object, Object, Consumer)

set

public static <T,U> boolean set(java.util.concurrent.atomic.AtomicReference<U> instance,
                                U newValue,
                                U terminalValue,
                                Consumer<? super U> onTerminate)

Atomically replaces the contents of the instance and calls the callback with the old value or calls the callback with the new value if the instance holds the terminal value.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

instance -

newValue -

terminalValue -

onTerminate -

Returns:

false if the instance holds the terminal value

See Also:

update(AtomicReference, Object, Object, Consumer)

update

public static <T,U> boolean update(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U> updater,
                                   T instance,
                                   U newValue,
                                   U terminalValue,
                                   Consumer<? super U> onTerminate)

Atomically replaces the content of the instance but calls the callback only if the instance holds the terminal value.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

updater -

instance -

newValue -

terminalValue -

onTerminate -

Returns:

false if the instance holds the terminal value

See Also:

set(AtomicReferenceFieldUpdater, Object, Object, Object, Consumer)

update

public static <T,U> boolean update(java.util.concurrent.atomic.AtomicReference<U> instance,
                                   U newValue,
                                   U terminalValue,
                                   Consumer<? super U> onTerminate)

Atomically replaces the content of the instance but calls the callback only if the instance holds the terminal value.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

instance -

newValue -

terminalValue -

onTerminate -

Returns:

false if the instance holds the terminal value

See Also:

set(AtomicReference, Object, Object, Consumer)

add

public static <T,U> boolean add(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U[]> updater,
                                T instance,
                                U newValue,
                                U[] terminalValue,
                                IntFunction<U[]> arraySupplier)

Atomically replaces the array in instance with a new array that contains the newValue as well or returns false if the instance holds the terminalValue.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

updater -

instance -

newValue -

terminalValue -

arraySupplier -

Returns:

true if the add succeeded, false if the instance has terminated

add

public static <U> boolean add(java.util.concurrent.atomic.AtomicReference<U[]> instance,
                              U newValue,
                              U[] terminalValue,
                              IntFunction<U[]> arraySupplier)

Atomically replaces the array in instance with a new array that contains the newValue as well or returns false if the instance holds the terminalValue.

Type Parameters:

U - the reference type

Parameters:

instance -

newValue -

terminalValue -

arraySupplier -

Returns:

true if the add succeeded, false if the instance has terminated

remove

public static <T,U> boolean remove(java.util.concurrent.atomic.AtomicReferenceFieldUpdater<T,U[]> updater,
                                   T instance,
                                   U value,
                                   U[] terminalValue,
                                   U[] zeroArray,
                                   IntFunction<U[]> arraySupplier)

Atomically replaces the array in instance with a new array that doesn't contain the given value or returns false if the instance holds the terminal state or an empty array or the value is not in the array.

Type Parameters:

T - the instance type

U - the reference type

Parameters:

updater -

instance -

value -

terminalValue -

zeroArray -

arraySupplier -

Returns:

true if the remove succeeded, false if the instance has terminated

remove

public static <U> boolean remove(java.util.concurrent.atomic.AtomicReference<U[]> reference,
                                 U value,
                                 U[] terminalValue,
                                 U[] zeroArray,
                                 IntFunction<U[]> arraySupplier)

Atomically replaces the array in instance with a new array that doesn't contain the given value or returns false if the instance holds the terminal state or an empty array or the value is not in the array.

Type Parameters:

U - the reference type

Parameters:

reference -

value -

terminalValue -

zeroArray -

arraySupplier -

Returns:

true if the remove succeeded, false if the instance has terminated