java.lang.Object
java.util.concurrent.atomic.AtomicReference<V>
- Type Parameters:
V
- The type of object referred to by this reference
- All Implemented Interfaces:
Serializable
An object reference that may be updated atomically. See the
VarHandle
specification for descriptions of the properties of
atomic accesses.- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorDescriptionCreates a new AtomicReference with null initial value.AtomicReference
(V initialValue) Creates a new AtomicReference with the given initial value. -
Method Summary
Modifier and TypeMethodDescriptionfinal V
accumulateAndGet
(V x, BinaryOperator<V> accumulatorFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value with the results of applying the given function to the current and given values, returning the updated value.final V
compareAndExchange
(V expectedValue, V newValue) Atomically sets the value tonewValue
if the current value, referred to as the witness value,== expectedValue
, with memory effects as specified byVarHandle.compareAndExchange(java.lang.Object...)
.final V
compareAndExchangeAcquire
(V expectedValue, V newValue) Atomically sets the value tonewValue
if the current value, referred to as the witness value,== expectedValue
, with memory effects as specified byVarHandle.compareAndExchangeAcquire(java.lang.Object...)
.final V
compareAndExchangeRelease
(V expectedValue, V newValue) Atomically sets the value tonewValue
if the current value, referred to as the witness value,== expectedValue
, with memory effects as specified byVarHandle.compareAndExchangeRelease(java.lang.Object...)
.final boolean
compareAndSet
(V expectedValue, V newValue) Atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
.final V
get()
Returns the current value, with memory effects as specified byVarHandle.getVolatile(java.lang.Object...)
.final V
Returns the current value, with memory effects as specified byVarHandle.getAcquire(java.lang.Object...)
.final V
getAndAccumulate
(V x, BinaryOperator<V> accumulatorFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value with the results of applying the given function to the current and given values, returning the previous value.final V
Atomically sets the value tonewValue
and returns the old value, with memory effects as specified byVarHandle.getAndSet(java.lang.Object...)
.final V
getAndUpdate
(UnaryOperator<V> updateFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value with the results of applying the given function, returning the previous value.final V
Returns the current value, with memory effects as specified byVarHandle.getOpaque(java.lang.Object...)
.final V
getPlain()
Returns the current value, with memory semantics of reading as if the variable was declared non-volatile
.final void
Sets the value tonewValue
, with memory effects as specified byVarHandle.setRelease(java.lang.Object...)
.final void
Sets the value tonewValue
, with memory effects as specified byVarHandle.setVolatile(java.lang.Object...)
.final void
Sets the value tonewValue
, with memory effects as specified byVarHandle.setOpaque(java.lang.Object...)
.final void
Sets the value tonewValue
, with memory semantics of setting as if the variable was declared non-volatile
and non-final
.final void
setRelease
(V newValue) Sets the value tonewValue
, with memory effects as specified byVarHandle.setRelease(java.lang.Object...)
.toString()
Returns the String representation of the current value.final V
updateAndGet
(UnaryOperator<V> updateFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value with the results of applying the given function, returning the updated value.final boolean
weakCompareAndSet
(V expectedValue, V newValue) Deprecated.final boolean
weakCompareAndSetAcquire
(V expectedValue, V newValue) Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetAcquire(java.lang.Object...)
.final boolean
weakCompareAndSetPlain
(V expectedValue, V newValue) Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetPlain(java.lang.Object...)
.final boolean
weakCompareAndSetRelease
(V expectedValue, V newValue) Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetRelease(java.lang.Object...)
.final boolean
weakCompareAndSetVolatile
(V expectedValue, V newValue) Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSet(java.lang.Object...)
.
-
Constructor Details
-
AtomicReference
Creates a new AtomicReference with the given initial value.- Parameters:
initialValue
- the initial value
-
AtomicReference
public AtomicReference()Creates a new AtomicReference with null initial value.
-
-
Method Details
-
get
Returns the current value, with memory effects as specified byVarHandle.getVolatile(java.lang.Object...)
.- Returns:
- the current value
-
set
Sets the value tonewValue
, with memory effects as specified byVarHandle.setVolatile(java.lang.Object...)
.- Parameters:
newValue
- the new value
-
lazySet
Sets the value tonewValue
, with memory effects as specified byVarHandle.setRelease(java.lang.Object...)
.- Parameters:
newValue
- the new value- Since:
- 1.6
-
compareAndSet
Atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
true
if successful. False return indicates that the actual value was not equal to the expected value.
-
weakCompareAndSet
Deprecated.This method has plain memory effects but the method name implies volatile memory effects (see methods such ascompareAndExchange(V, V)
andcompareAndSet(V, V)
). To avoid confusion over plain or volatile memory effects it is recommended that the methodweakCompareAndSetPlain(V, V)
be used instead.Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetPlain(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
true
if successful- See Also:
-
weakCompareAndSetPlain
Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetPlain(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
true
if successful- Since:
- 9
-
getAndSet
Atomically sets the value tonewValue
and returns the old value, with memory effects as specified byVarHandle.getAndSet(java.lang.Object...)
.- Parameters:
newValue
- the new value- Returns:
- the previous value
-
getAndUpdate
Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value 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.- Parameters:
updateFunction
- a side-effect-free function- Returns:
- the previous value
- Since:
- 1.8
-
updateAndGet
Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value 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.- Parameters:
updateFunction
- a side-effect-free function- Returns:
- the updated value
- Since:
- 1.8
-
getAndAccumulate
Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value 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 as its first argument, and the given update as the second argument.- Parameters:
x
- the update valueaccumulatorFunction
- a side-effect-free function of two arguments- Returns:
- the previous value
- Since:
- 1.8
-
accumulateAndGet
Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)
) the current value 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 as its first argument, and the given update as the second argument.- Parameters:
x
- the update valueaccumulatorFunction
- a side-effect-free function of two arguments- Returns:
- the updated value
- Since:
- 1.8
-
toString
-
getPlain
Returns the current value, with memory semantics of reading as if the variable was declared non-volatile
.- Returns:
- the value
- Since:
- 9
-
setPlain
Sets the value tonewValue
, with memory semantics of setting as if the variable was declared non-volatile
and non-final
.- Parameters:
newValue
- the new value- Since:
- 9
-
getOpaque
Returns the current value, with memory effects as specified byVarHandle.getOpaque(java.lang.Object...)
.- Returns:
- the value
- Since:
- 9
-
setOpaque
Sets the value tonewValue
, with memory effects as specified byVarHandle.setOpaque(java.lang.Object...)
.- Parameters:
newValue
- the new value- Since:
- 9
-
getAcquire
Returns the current value, with memory effects as specified byVarHandle.getAcquire(java.lang.Object...)
.- Returns:
- the value
- Since:
- 9
-
setRelease
Sets the value tonewValue
, with memory effects as specified byVarHandle.setRelease(java.lang.Object...)
.- Parameters:
newValue
- the new value- Since:
- 9
-
compareAndExchange
Atomically sets the value tonewValue
if the current value, referred to as the witness value,== expectedValue
, with memory effects as specified byVarHandle.compareAndExchange(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
- the witness value, which will be the same as the expected value if successful
- Since:
- 9
-
compareAndExchangeAcquire
Atomically sets the value tonewValue
if the current value, referred to as the witness value,== expectedValue
, with memory effects as specified byVarHandle.compareAndExchangeAcquire(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
- the witness value, which will be the same as the expected value if successful
- Since:
- 9
-
compareAndExchangeRelease
Atomically sets the value tonewValue
if the current value, referred to as the witness value,== expectedValue
, with memory effects as specified byVarHandle.compareAndExchangeRelease(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
- the witness value, which will be the same as the expected value if successful
- Since:
- 9
-
weakCompareAndSetVolatile
Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSet(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
true
if successful- Since:
- 9
-
weakCompareAndSetAcquire
Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetAcquire(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
true
if successful- Since:
- 9
-
weakCompareAndSetRelease
Possibly atomically sets the value tonewValue
if the current value== expectedValue
, with memory effects as specified byVarHandle.weakCompareAndSetRelease(java.lang.Object...)
.- Parameters:
expectedValue
- the expected valuenewValue
- the new value- Returns:
true
if successful- Since:
- 9
-
compareAndExchange(V, V)
andcompareAndSet(V, V)
).