Skip to content

Most visited

Recently visited

navigation
Added in API level 1

AtomicReference

public class AtomicReference
extends Object implements Serializable

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


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.

Inherited methods

From class java.lang.Object

Public constructors

AtomicReference

Added in API level 1
AtomicReference (V initialValue)

Creates a new AtomicReference with the given initial value.

Parameters
initialValue V: the initial value

AtomicReference

Added in API level 1
AtomicReference ()

Creates a new AtomicReference with null initial value.

Public methods

compareAndSet

Added in API level 1
boolean compareAndSet (V expect, 
                V update)

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.

get

Added in API level 1
V get ()

Gets the current value.

Returns
V the current value

getAndSet

Added in API level 1
V getAndSet (V newValue)

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

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

lazySet

Added in API level 9
void lazySet (V newValue)

Eventually sets to the given value.

Parameters
newValue V: the new value

set

Added in API level 1
void set (V newValue)

Sets to the given value.

Parameters
newValue V: the new value

toString

Added in API level 1
String toString ()

Returns the String representation of the current value.

Returns
String the String representation of the current value

weakCompareAndSet

Added in API level 1
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, 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
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.