E
- The base class of elements held in this arraySerializable
public class AtomicReferenceArray<E> extends Object implements Serializable
VarHandle
specification for descriptions of the properties of atomic accesses.Constructor | Description |
---|---|
AtomicReferenceArray |
Creates a new AtomicReferenceArray of the given length, with all elements initially null. |
AtomicReferenceArray |
Creates a new AtomicReferenceArray with the same length as, and all elements copied from, the given array. |
Modifier and Type | Method | Description |
---|---|---|
final E |
accumulateAndGet |
Atomically updates (with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...) ) the element at index i with the results of applying the given function to the current and given values, returning the updated value. |
final E |
compareAndExchange |
Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue , with memory effects as specified by VarHandle.compareAndExchange(java.lang.Object...) . |
final E |
compareAndExchangeAcquire |
Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue , with memory effects as specified by VarHandle.compareAndExchangeAcquire(java.lang.Object...) . |
final E |
compareAndExchangeRelease |
Atomically sets the element at index i to newValue if the element's current value, referred to as the witness value, == expectedValue , with memory effects as specified by VarHandle.compareAndExchangeRelease(java.lang.Object...) . |
final boolean |
compareAndSet |
Atomically sets the element at index i to newValue if the element's current value == expectedValue , with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...) . |
final E |
get |
Returns the current value of the element at index i , with memory effects as specified by VarHandle.getVolatile(java.lang.Object...) . |
final E |
getAcquire |
Returns the current value of the element at index i , with memory effects as specified by VarHandle.getAcquire(java.lang.Object...) . |
final E |
getAndAccumulate |
Atomically updates (with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...) ) the element at index i with the results of applying the given function to the current and given values, returning the previous value. |
final E |
getAndSet |
Atomically sets the element at index i to
newValue and returns the old value, with memory effects as specified by VarHandle.getAndSet(java.lang.Object...) . |
final E |
getAndUpdate |
Atomically updates (with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...) ) the element at index i with the results of applying the given function, returning the previous value. |
final E |
getOpaque |
Returns the current value of the element at index i , with memory effects as specified by VarHandle.getOpaque(java.lang.Object...) . |
final E |
getPlain |
Returns the current value of the element at index i , with memory semantics of reading as if the variable was declared non-volatile . |
final void |
lazySet |
Sets the element at index i to newValue , with memory effects as specified by VarHandle.setRelease(java.lang.Object...) . |
final int |
length() |
Returns the length of the array. |
final void |
set |
Sets the element at index i to newValue , with memory effects as specified by VarHandle.setVolatile(java.lang.Object...) . |
final void |
setOpaque |
Sets the element at index i to newValue , with memory effects as specified by VarHandle.setOpaque(java.lang.Object...) . |
final void |
setPlain |
Sets the element at index i to newValue , with memory semantics of setting as if the variable was declared non-volatile and non-final . |
final void |
setRelease |
Sets the element at index i to newValue , with memory effects as specified by VarHandle.setRelease(java.lang.Object...) . |
String |
toString() |
Returns the String representation of the current values of array. |
final E |
updateAndGet |
Atomically updates (with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...) ) the element at index i with the results of applying the given function, returning the updated value. |
final boolean |
weakCompareAndSet |
Deprecated. |
final boolean |
weakCompareAndSetAcquire |
Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue , with memory effects as specified by VarHandle.weakCompareAndSetAcquire(java.lang.Object...) . |
final boolean |
weakCompareAndSetPlain |
Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue , with memory effects as specified by VarHandle.weakCompareAndSetPlain(java.lang.Object...) . |
final boolean |
weakCompareAndSetRelease |
Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue , with memory effects as specified by VarHandle.weakCompareAndSetRelease(java.lang.Object...) . |
final boolean |
weakCompareAndSetVolatile |
Possibly atomically sets the element at index i to newValue if the element's current value == expectedValue , with memory effects as specified by VarHandle.weakCompareAndSet(java.lang.Object...) . |
public AtomicReferenceArray(int length)
length
- the length of the arraypublic AtomicReferenceArray(E[] array)
array
- the array to copy elements fromNullPointerException
- if array is nullpublic final int length()
public final E get(int i)
i
, with memory effects as specified by VarHandle.getVolatile(java.lang.Object...)
.i
- the indexpublic final void set(int i, E newValue)
i
to newValue
, with memory effects as specified by VarHandle.setVolatile(java.lang.Object...)
.i
- the indexnewValue
- the new valuepublic final void lazySet(int i, E newValue)
i
to newValue
, with memory effects as specified by VarHandle.setRelease(java.lang.Object...)
.i
- the indexnewValue
- the new valuepublic final E getAndSet(int i, E newValue)
i
to
newValue
and returns the old value, with memory effects as specified by VarHandle.getAndSet(java.lang.Object...)
.i
- the indexnewValue
- the new valuepublic final boolean compareAndSet(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value == expectedValue
, with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuetrue
if successful. False return indicates that the actual value was not equal to the expected value.@Deprecated(since="9") public final boolean weakCompareAndSet(int i, E expectedValue, E newValue)
compareAndExchange(int, E, E)
and compareAndSet(int, E, E)
). To avoid confusion over plain or volatile memory effects it is recommended that the method weakCompareAndSetPlain(int, E, E)
be used instead.i
to newValue
if the element's current value == expectedValue
, with memory effects as specified by VarHandle.weakCompareAndSetPlain(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuetrue
if successfulpublic final boolean weakCompareAndSetPlain(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value == expectedValue
, with memory effects as specified by VarHandle.weakCompareAndSetPlain(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuetrue
if successfulpublic final E getAndUpdate(int i, UnaryOperator<E> updateFunction)
VarHandle.compareAndSet(java.lang.Object...)
) the element at index i
with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.i
- the indexupdateFunction
- a side-effect-free functionpublic final E updateAndGet(int i, UnaryOperator<E> updateFunction)
VarHandle.compareAndSet(java.lang.Object...)
) the element at index i
with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.i
- the indexupdateFunction
- a side-effect-free functionpublic final E getAndAccumulate(int i, E x, BinaryOperator<E> accumulatorFunction)
VarHandle.compareAndSet(java.lang.Object...)
) the element at index i
with the results of applying the given function to the current and given values, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value of the element at index i
as its first argument, and the given update as the second argument.i
- the indexx
- the update valueaccumulatorFunction
- a side-effect-free function of two argumentspublic final E accumulateAndGet(int i, E x, BinaryOperator<E> accumulatorFunction)
VarHandle.compareAndSet(java.lang.Object...)
) the element at index i
with the results of applying the given function to the current and given values, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value of the element at index i
as its first argument, and the given update as the second argument.i
- the indexx
- the update valueaccumulatorFunction
- a side-effect-free function of two argumentspublic String toString()
public final E getPlain(int i)
i
, with memory semantics of reading as if the variable was declared non-volatile
.i
- the indexpublic final void setPlain(int i, E newValue)
i
to newValue
, with memory semantics of setting as if the variable was declared non-volatile
and non-final
.i
- the indexnewValue
- the new valuepublic final E getOpaque(int i)
i
, with memory effects as specified by VarHandle.getOpaque(java.lang.Object...)
.i
- the indexpublic final void setOpaque(int i, E newValue)
i
to newValue
, with memory effects as specified by VarHandle.setOpaque(java.lang.Object...)
.i
- the indexnewValue
- the new valuepublic final E getAcquire(int i)
i
, with memory effects as specified by VarHandle.getAcquire(java.lang.Object...)
.i
- the indexpublic final void setRelease(int i, E newValue)
i
to newValue
, with memory effects as specified by VarHandle.setRelease(java.lang.Object...)
.i
- the indexnewValue
- the new valuepublic final E compareAndExchange(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value, referred to as the witness value, == expectedValue
, with memory effects as specified by VarHandle.compareAndExchange(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuepublic final E compareAndExchangeAcquire(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value, referred to as the witness value, == expectedValue
, with memory effects as specified by VarHandle.compareAndExchangeAcquire(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuepublic final E compareAndExchangeRelease(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value, referred to as the witness value, == expectedValue
, with memory effects as specified by VarHandle.compareAndExchangeRelease(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuepublic final boolean weakCompareAndSetVolatile(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value == expectedValue
, with memory effects as specified by VarHandle.weakCompareAndSet(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuetrue
if successfulpublic final boolean weakCompareAndSetAcquire(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value == expectedValue
, with memory effects as specified by VarHandle.weakCompareAndSetAcquire(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuetrue
if successfulpublic final boolean weakCompareAndSetRelease(int i, E expectedValue, E newValue)
i
to newValue
if the element's current value == expectedValue
, with memory effects as specified by VarHandle.weakCompareAndSetRelease(java.lang.Object...)
.i
- the indexexpectedValue
- the expected valuenewValue
- the new valuetrue
if successful
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/concurrent/atomic/AtomicReferenceArray.html
compareAndExchange(int, E, E)
andcompareAndSet(int, E, E)
).