AtomicReferenceFieldUpdaterpublic abstract class AtomicReferenceFieldUpdater extends Object A reflection-based utility that enables atomic updates to
designated {@code volatile} reference fields of designated
classes. This class is designed for use in atomic data structures
in which several reference fields of the same node are
independently subject to atomic updates. For example, a tree node
might be declared as
class Node {
private volatile Node left, right;
private static final AtomicReferenceFieldUpdater<Node, Node> leftUpdater =
AtomicReferenceFieldUpdater.newUpdater(Node.class, Node.class, "left");
private static AtomicReferenceFieldUpdater<Node, Node> rightUpdater =
AtomicReferenceFieldUpdater.newUpdater(Node.class, Node.class, "right");
Node getLeft() { return left; }
boolean compareAndSetLeft(Node expect, Node update) {
return leftUpdater.compareAndSet(this, expect, update);
}
// ... and so on
}
Note that the guarantees of the {@code compareAndSet}
method in this class are weaker than in other atomic classes.
Because this class cannot ensure that all uses of the field
are appropriate for purposes of atomic access, it can
guarantee atomicity only with respect to other invocations of
{@code compareAndSet} and {@code set} on the same updater. |
Constructors Summary |
---|
protected AtomicReferenceFieldUpdater()Protected do-nothing constructor for use by subclasses.
|
Methods Summary |
---|
public abstract boolean | compareAndSet(T obj, V expect, V update)Atomically sets the field of the given object managed by this updater
to the given updated value if the current value {@code ==} the
expected value. This method is guaranteed to be atomic with respect to
other calls to {@code compareAndSet} and {@code set}, but not
necessarily with respect to other changes in the field.
| public abstract V | get(T obj)Gets the current value held in the field of the given object managed
by this updater.
| public V | getAndSet(T obj, V newValue)Atomically sets the field of the given object managed by this updater
to the given value and returns the old value.
for (;;) {
V current = get(obj);
if (compareAndSet(obj, current, newValue))
return current;
}
| public abstract void | lazySet(T obj, V newValue)Eventually sets the field of the given object managed by this
updater to the given updated value.
| public static java.util.concurrent.atomic.AtomicReferenceFieldUpdater | newUpdater(java.lang.Class tclass, java.lang.Class vclass, java.lang.String fieldName)Creates and returns an updater for objects with the given field.
The Class arguments are needed to check that reflective types and
generic types match.
return new AtomicReferenceFieldUpdaterImpl<U,W>(tclass,
vclass,
fieldName);
| public abstract void | set(T obj, V newValue)Sets the field of the given object managed by this updater to the
given updated value. This operation is guaranteed to act as a volatile
store with respect to subsequent invocations of {@code compareAndSet}.
| public abstract boolean | weakCompareAndSet(T obj, V expect, V update)Atomically sets the field of the given object managed by this updater
to the given updated value if the current value {@code ==} the
expected value. This method is guaranteed to be atomic with respect to
other calls to {@code compareAndSet} and {@code set}, but not
necessarily with respect to other changes in the field.
May fail spuriously
and does not provide ordering guarantees, so is only rarely an
appropriate alternative to {@code compareAndSet}.
|
|