Android APIs
public class

AtomicReference

extends Object
implements Serializable
java.lang.Object
   ↳ java.util.concurrent.atomic.AtomicReference<V>

Class Overview

An object reference that may be updated atomically. See the java.util.concurrent.atomic package specification for description of the properties of atomic variables.

Summary

Public Constructors
AtomicReference(V initialValue)
Creates a new AtomicReference with the given initial value.
AtomicReference()
Creates a new AtomicReference with null initial value.
Public Methods
final boolean compareAndSet(V expect, V update)
Atomically sets the value to the given updated value if the current value == the expected value.
final V get()
Gets the current value.
final V getAndSet(V newValue)
Atomically sets to the given value and returns the old value.
final void lazySet(V newValue)
Eventually sets to the given value.
final void set(V newValue)
Sets to the given value.
String toString()
Returns the String representation of the current value.
final boolean weakCompareAndSet(V expect, V update)
Atomically sets the value to the given updated value if the current value == the expected value.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public AtomicReference (V initialValue)

Added in API level 1

Creates a new AtomicReference with the given initial value.

Parameters
initialValue V: the initial value

public AtomicReference ()

Added in API level 1

Creates a new AtomicReference with null initial value.

Public Methods

public final boolean compareAndSet (V expect, V update)

Added in API level 1

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

Parameters
expect V: the expected value
update V: the new value
Returns
boolean true if successful. False return indicates that the actual value was not equal to the expected value.

public final V get ()

Added in API level 1

Gets the current value.

Returns
V the current value

public final V getAndSet (V newValue)

Added in API level 1

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

Parameters
newValue V: the new value
Returns
V the previous value

public final void lazySet (V newValue)

Added in API level 9

Eventually sets to the given value.

Parameters
newValue V: the new value

public final void set (V newValue)

Added in API level 1

Sets to the given value.

Parameters
newValue V: the new value

public String toString ()

Added in API level 1

Returns the String representation of the current value.

Returns
String the String representation of the current value

public final boolean weakCompareAndSet (V expect, V update)

Added in API level 1

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, so is only rarely an appropriate alternative to compareAndSet.

Parameters
expect V: the expected value
update V: the new value
Returns
boolean true if successful