java.util.concurrent.atomic: public class: AtomicReference

java.util.concurrent.atomic
public class: AtomicReference [javadoc | source]

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

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
Node, Slot

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

Parameters:

< - V> The type of object referred to by this reference

since: 1.5 -

author: Doug - Lea

Constructor:

Constructor:
public AtomicReference() { } Creates a new AtomicReference with null initial value.
public AtomicReference(V initialValue) { value = 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 AtomicReference(V initialValue) {
        value = initialValue;
}

Creates a new AtomicReference with the given initial value.

Parameters:

initialValue - the initial value

Method from java.util.concurrent.atomic.AtomicReference Summary:
compareAndSet, get, getAndSet, lazySet, set, toString, weakCompareAndSet

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from java.util.concurrent.atomic.AtomicReference Detail:
public final boolean compareAndSet(V expect, V update) { return unsafe.compareAndSwapObject(this, valueOffset, expect, update); } Atomically sets the value to the given updated value if the current value {@code ==} the expected value.
public final V get() { return value; } Gets the current value.
public final V getAndSet(V newValue) { while (true) { V x = get(); if (compareAndSet(x, newValue)) return x; } } Atomically sets to the given value and returns the old value.
public final void lazySet(V newValue) { unsafe.putOrderedObject(this, valueOffset, newValue); } Eventually sets to the given value.
public final void set(V newValue) { value = newValue; } Sets to the given value.
public String toString() { return String.valueOf(get()); } Returns the String representation of the current value.
public final boolean weakCompareAndSet(V expect, V update) { return unsafe.compareAndSwapObject(this, valueOffset, expect, 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}.

Method from java.util.concurrent.atomic.AtomicReference Detail:

 public final boolean compareAndSet(V expect,
    V update) {
        return unsafe.compareAndSwapObject(this, valueOffset, expect, update);
}

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

 public final V get() {
        return value;
}

Gets the current value.

 public final V getAndSet(V newValue) {
        while (true) {
            V x = get();
            if (compareAndSet(x, newValue))
                return x;
        }
}

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

 public final  void lazySet(V newValue) {
        unsafe.putOrderedObject(this, valueOffset, newValue);
}

Eventually sets to the given value.

 public final  void set(V newValue) {
        value = newValue;
}

Sets to the given value.

 public String toString() {
        return String.valueOf(get());
}

Returns the String representation of the current value.

 public final boolean weakCompareAndSet(V expect,
    V update) {
        return unsafe.compareAndSwapObject(this, valueOffset, expect, update);
}

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