java.util.concurrent.atomic
class AtomicReference

java.lang.Object java.util.concurrent.atomic.AtomicReference

All Implemented Interfaces:

Serializable

Most common way to construct:

Integer one = …;

AtomicReference ai = new AtomicReference(one);

Based on 87 examples

public class AtomicReference
extends Object
implements Serializable

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

AtomicReference

public AtomicReference()

Creates a new AtomicReference with null initial value.

AtomicReference

public AtomicReference(Object initialValue)

Creates a new AtomicReference with the given initial value.

Parameters:

initialValue - the initial value

compareAndSet

public final boolean compareAndSet(Object expect,
                                   Object update)

Atomically sets the value to the given updated value if the current value {@code ==} 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.

get

public final Object get()

Gets the current value.

Returns:

the current value

getAndSet

public final Object getAndSet(Object newValue)

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

Parameters:

newValue - the new value

Returns:

the previous value

lazySet

public final void lazySet(Object newValue)

Eventually sets to the given value.

Parameters:

newValue - the new value

set

public final void set(Object newValue)

Sets to the given value.

Parameters:

newValue - the new value

toString

public String toString()

Returns the String representation of the current value.

Overrides:

toString in class Object

Returns:

the String representation of the current value.

weakCompareAndSet

public final boolean weakCompareAndSet(Object expect,
                                       Object update)

Atomically sets the value to the given updated value if the current value {@code ==} the expected value.

May fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to {@code compareAndSet}.

Parameters:

expect - the expected value

update - the new value

Returns:

true if successful.