# AtomicReference

public class **AtomicReference** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
implements [Serializable](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/Serializable.html) An object reference that may be updated atomically. See the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/package-summary.html` package specification for description
of the properties of atomic variables.

### Public Constructor Summary

|---|---|
|   | [AtomicReference](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#AtomicReference(V))(V initialValue) Creates a new AtomicReference with the given initial value. |
|   | [AtomicReference](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#AtomicReference())() Creates a new AtomicReference with null initial value. |

### Public Method Summary

|---|---|
| final V | [accumulateAndGet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#accumulateAndGet(V,%20java.util.function.BinaryOperator<V>))(V x, [BinaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BinaryOperator.html)\<V\> accumulatorFunction) Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value. |
| final boolean | [compareAndSet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#compareAndSet(V,%20V))(V expect, V update) Atomically sets the value to the given updated value if the current value `==` the expected value. |
| final V | [get](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#get())() Gets the current value. |
| final V | [getAndAccumulate](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#getAndAccumulate(V,%20java.util.function.BinaryOperator<V>))(V x, [BinaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BinaryOperator.html)\<V\> accumulatorFunction) Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value. |
| final V | [getAndSet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#getAndSet(V))(V newValue) Atomically sets to the given value and returns the old value. |
| final V | [getAndUpdate](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#getAndUpdate(java.util.function.UnaryOperator<V>))([UnaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/UnaryOperator.html)\<V\> updateFunction) Atomically updates the current value with the results of applying the given function, returning the previous value. |
| final void | [lazySet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#lazySet(V))(V newValue) Eventually sets to the given value. |
| final void | [set](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#set(V))(V newValue) Sets to the given value. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#toString())() Returns the String representation of the current value. |
| final V | [updateAndGet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#updateAndGet(java.util.function.UnaryOperator<V>))([UnaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/UnaryOperator.html)\<V\> updateFunction) Atomically updates the current value with the results of applying the given function, returning the updated value. |
| final boolean | [weakCompareAndSet](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/AtomicReference.html#weakCompareAndSet(V,%20V))(V expect, V update) Atomically sets the value to the given updated value if the current value `==` the expected value. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Public Constructors

#### public
**AtomicReference**
(V initialValue)

Creates a new AtomicReference with the given initial value.

##### Parameters

| initialValue | the initial value |
|---|---|

#### public
**AtomicReference**
()

Creates a new AtomicReference with null initial value.

## Public Methods

#### public final V
**accumulateAndGet**
(V x, [BinaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BinaryOperator.html)\<V\> accumulatorFunction)

Atomically updates 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

#### public final boolean
**compareAndSet**
(V expect, V update)

Atomically sets the value to the given updated value
if the current value `==` the expected value.

##### Parameters

| expect | the expected value |
| update | the new value |
|---|---|

##### Returns

- `true` if successful. False return indicates that the actual value was not equal to the expected value.

#### public final V
**get**
()

Gets the current value.

##### Returns

- the current value

#### public final V
**getAndAccumulate**
(V x, [BinaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/BinaryOperator.html)\<V\> accumulatorFunction)

Atomically updates 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

#### public final V
**getAndSet**
(V newValue)

Atomically sets to the given value and returns the old value.

##### Parameters

| newValue | the new value |
|---|---|

##### Returns

- the previous value

#### public final V
**getAndUpdate**
([UnaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/UnaryOperator.html)\<V\> updateFunction)

Atomically updates 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

#### public final void
**lazySet**
(V newValue)

Eventually sets to the given value.

##### Parameters

| newValue | the new value |
|---|---|

#### public final void
**set**
(V newValue)

Sets to the given value.

##### Parameters

| newValue | the new value |
|---|---|

#### public [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**toString**
()

Returns the String representation of the current value.

##### Returns

- the String representation of the current value

#### public final V
**updateAndGet**
([UnaryOperator](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/function/UnaryOperator.html)\<V\> updateFunction)

Atomically updates 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

#### public final boolean
**weakCompareAndSet**
(V expect, V update)

Atomically sets the value to the given updated value
if the current value `==` the expected value.

[May fail
spuriously and does not provide ordering guarantees](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/atomic/package-summary#weakCompareAndSet), so is
only rarely an appropriate alternative to `compareAndSet`.

##### Parameters

| expect | the expected value |
| update | the new value |
|---|---|

##### Returns

- `true` if successful