AtomicReference (Java SE 9 & JDK 9 ) (original) (raw)

Constructor Summary

Constructors

Constructor	Description
AtomicReference()	Creates a new AtomicReference with null initial value.
AtomicReference(V initialValue)	Creates a new AtomicReference with the given initial value.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods

Modifier and Type	Method	Description
V	accumulateAndGet(V x,BinaryOperator<V> accumulatorFunction)	Atomically updates (with memory effects as specified by VarHandle.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.
V	compareAndExchange(V expectedValue,V newValue)	Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue, with memory effects as specified byVarHandle.compareAndExchange(java.lang.Object...).
V	compareAndExchangeAcquire(V expectedValue,V newValue)	Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue, with memory effects as specified byVarHandle.compareAndExchangeAcquire(java.lang.Object...).
V	compareAndExchangeRelease(V expectedValue,V newValue)	Atomically sets the value to newValue if the current value, referred to as the witness value, == expectedValue, with memory effects as specified byVarHandle.compareAndExchangeRelease(java.lang.Object...).
boolean	compareAndSet(V expectedValue,V newValue)	Atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...).
V	get()	Returns the current value, with memory effects as specified by VarHandle.getVolatile(java.lang.Object...).
V	getAcquire()	Returns the current value, with memory effects as specified by VarHandle.getAcquire(java.lang.Object...).
V	getAndAccumulate(V x,BinaryOperator<V> accumulatorFunction)	Atomically updates (with memory effects as specified by VarHandle.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.
V	getAndSet(V newValue)	Atomically sets the value to newValue and returns the old value, with memory effects as specified by VarHandle.getAndSet(java.lang.Object...).
V	getAndUpdate(UnaryOperator<V> updateFunction)	Atomically updates (with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...)) the current value with the results of applying the given function, returning the previous value.
V	getOpaque()	Returns the current value, with memory effects as specified by VarHandle.getOpaque(java.lang.Object...).
V	getPlain()	Returns the current value, with memory semantics of reading as if the variable was declared non-volatile.
void	lazySet(V newValue)	Sets the value to newValue, with memory effects as specified by VarHandle.setRelease(java.lang.Object...).
void	set(V newValue)	Sets the value to newValue, with memory effects as specified by VarHandle.setVolatile(java.lang.Object...).
void	setOpaque(V newValue)	Sets the value to newValue, with memory effects as specified by VarHandle.setOpaque(java.lang.Object...).
void	setPlain(V newValue)	Sets the value to newValue, with memory semantics of setting as if the variable was declared non-volatile and non-final.
void	setRelease(V newValue)	Sets the value to newValue, with memory effects as specified by VarHandle.setRelease(java.lang.Object...).
String	toString()	Returns the String representation of the current value.
V	updateAndGet(UnaryOperator<V> updateFunction)	Atomically updates (with memory effects as specified by VarHandle.compareAndSet(java.lang.Object...)) the current value with the results of applying the given function, returning the updated value.
boolean	weakCompareAndSet(V expectedValue,V newValue)	Deprecated.
boolean	weakCompareAndSetAcquire(V expectedValue,V newValue)	Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetAcquire(java.lang.Object...).
boolean	weakCompareAndSetPlain(V expectedValue,V newValue)	Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified by VarHandle.weakCompareAndSetPlain(java.lang.Object...).
boolean	weakCompareAndSetRelease(V expectedValue,V newValue)	Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified byVarHandle.weakCompareAndSetRelease(java.lang.Object...).
boolean	weakCompareAndSetVolatile(V expectedValue,V newValue)	Possibly atomically sets the value to newValue if the current value == expectedValue, with memory effects as specified byVarHandle.weakCompareAndSet(java.lang.Object...).

   * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### AtomicReference  
 public AtomicReference([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") initialValue)  
 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 Detail

* #### get  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") get()  
Returns:  
the current value  
* #### set  
public final void set([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`newValue` \- the new value  
* #### lazySet  
public final void lazySet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`newValue` \- the new value  
Since:  
1.6  
* #### compareAndSet  
public final boolean compareAndSet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                   [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
`true` if successful. False return indicates that the actual value was not equal to the expected value.  
* #### weakCompareAndSet  
[@Deprecated](../../../../java/lang/Deprecated.html "annotation in java.lang")([since](../../../../java/lang/Deprecated.html#since--)="9")  
public final boolean weakCompareAndSet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                       [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Deprecated.  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
`true` if successful  
See Also:  
[weakCompareAndSetPlain(V, V)](../../../../java/util/concurrent/atomic/AtomicReference.html#weakCompareAndSetPlain-V-V-)  
* #### weakCompareAndSetPlain  
public final boolean weakCompareAndSetPlain([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                            [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
`true` if successful  
Since:  
9  
* #### getAndSet  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getAndSet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`newValue` \- the new value  
Returns:  
the previous value  
* #### getAndUpdate  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getAndUpdate([UnaryOperator](../../../../java/util/function/UnaryOperator.html "interface in java.util.function")<[V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference")> updateFunction)  
Atomically updates (with memory effects as specified by [VarHandle.compareAndSet(java.lang.Object...)](../../../../java/lang/invoke/VarHandle.html#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  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") updateAndGet([UnaryOperator](../../../../java/util/function/UnaryOperator.html "interface in java.util.function")<[V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference")> updateFunction)  
Atomically updates (with memory effects as specified by [VarHandle.compareAndSet(java.lang.Object...)](../../../../java/lang/invoke/VarHandle.html#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  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getAndAccumulate([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") x,  
                                [BinaryOperator](../../../../java/util/function/BinaryOperator.html "interface in java.util.function")<[V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference")> accumulatorFunction)  
Atomically updates (with memory effects as specified by [VarHandle.compareAndSet(java.lang.Object...)](../../../../java/lang/invoke/VarHandle.html#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 value  
`accumulatorFunction` \- a side-effect-free function of two arguments  
Returns:  
the previous value  
Since:  
1.8  
* #### accumulateAndGet  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") accumulateAndGet([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") x,  
                                [BinaryOperator](../../../../java/util/function/BinaryOperator.html "interface in java.util.function")<[V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference")> accumulatorFunction)  
Atomically updates (with memory effects as specified by [VarHandle.compareAndSet(java.lang.Object...)](../../../../java/lang/invoke/VarHandle.html#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 value  
`accumulatorFunction` \- a side-effect-free function of two arguments  
Returns:  
the updated value  
Since:  
1.8  
* #### toString  
public [String](../../../../java/lang/String.html "class in java.lang") toString()  
Returns the String representation of the current value.  
Overrides:  
`[toString](../../../../java/lang/Object.html#toString--)` in class `[Object](../../../../java/lang/Object.html "class in java.lang")`  
Returns:  
the String representation of the current value  
* #### getPlain  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getPlain()  
Returns the current value, with memory semantics of reading as if the variable was declared non-`volatile`.  
Returns:  
the value  
Since:  
9  
* #### setPlain  
public final void setPlain([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Sets the value to `newValue`, with memory semantics of setting as if the variable was declared non-`volatile` and non-`final`.  
Parameters:  
`newValue` \- the new value  
Since:  
9  
* #### getOpaque  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getOpaque()  
Returns:  
the value  
Since:  
9  
* #### setOpaque  
public final void setOpaque([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`newValue` \- the new value  
Since:  
9  
* #### getAcquire  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") getAcquire()  
Returns:  
the value  
Since:  
9  
* #### setRelease  
public final void setRelease([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`newValue` \- the new value  
Since:  
9  
* #### compareAndExchange  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") compareAndExchange([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                  [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Atomically sets the value to `newValue` if the current value, referred to as the _witness value_, `== expectedValue`, with memory effects as specified by[VarHandle.compareAndExchange(java.lang.Object...)](../../../../java/lang/invoke/VarHandle.html#compareAndExchange-java.lang.Object...-).  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
the witness value, which will be the same as the expected value if successful  
Since:  
9  
* #### compareAndExchangeAcquire  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") compareAndExchangeAcquire([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                         [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
the witness value, which will be the same as the expected value if successful  
Since:  
9  
* #### compareAndExchangeRelease  
public final [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") compareAndExchangeRelease([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                         [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
the witness value, which will be the same as the expected value if successful  
Since:  
9  
* #### weakCompareAndSetVolatile  
public final boolean weakCompareAndSetVolatile([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                               [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
`true` if successful  
Since:  
9  
* #### weakCompareAndSetAcquire  
public final boolean weakCompareAndSetAcquire([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                              [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
`true` if successful  
Since:  
9  
* #### weakCompareAndSetRelease  
public final boolean weakCompareAndSetRelease([V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") expectedValue,  
                                              [V](../../../../java/util/concurrent/atomic/AtomicReference.html "type parameter in AtomicReference") newValue)  
Parameters:  
`expectedValue` \- the expected value  
`newValue` \- the new value  
Returns:  
`true` if successful  
Since:  
9

AtomicReference (Java SE 9 & JDK 9 ) (original) (raw)

Constructor Summary

Method Summary

Constructor Detail

Method Detail