FileDocCategorySizeDatePackage
AtomicIntegerFieldUpdater.javaAPI DocJava SE 6 API11160Tue Jun 10 00:25:58 BST 2008java.util.concurrent.atomic

AtomicIntegerFieldUpdater

public abstract class AtomicIntegerFieldUpdater extends Object
A reflection-based utility that enables atomic updates to designated {@code volatile int} fields of designated classes. This class is designed for use in atomic data structures in which several fields of the same node are independently subject to atomic updates.

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.

since
1.5
author
Doug Lea
param
The type of the object holding the updatable field

Fields Summary
Constructors Summary
protected AtomicIntegerFieldUpdater()
Protected do-nothing constructor for use by subclasses.

    
Methods Summary
public intaddAndGet(T obj, int delta)
Atomically adds the given value to the current value of the field of the given object managed by this updater.

param
obj An object whose field to get and set
param
delta the value to add
return
the updated value

        for (;;) {
            int current = get(obj);
            int next = current + delta;
            if (compareAndSet(obj, current, next))
                return next;
        }
    
public abstract booleancompareAndSet(T obj, int expect, int 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.

param
obj An object whose field to conditionally set
param
expect the expected value
param
update the new value
return
true if successful
throws
ClassCastException if {@code obj} is not an instance of the class possessing the field established in the constructor

public intdecrementAndGet(T obj)
Atomically decrements by one the current value of the field of the given object managed by this updater.

param
obj An object whose field to get and set
return
the updated value

        for (;;) {
            int current = get(obj);
            int next = current - 1;
            if (compareAndSet(obj, current, next))
                return next;
        }
    
public abstract intget(T obj)
Gets the current value held in the field of the given object managed by this updater.

param
obj An object whose field to get
return
the current value

public intgetAndAdd(T obj, int delta)
Atomically adds the given value to the current value of the field of the given object managed by this updater.

param
obj An object whose field to get and set
param
delta the value to add
return
the previous value

        for (;;) {
            int current = get(obj);
            int next = current + delta;
            if (compareAndSet(obj, current, next))
                return current;
        }
    
public intgetAndDecrement(T obj)
Atomically decrements by one the current value of the field of the given object managed by this updater.

param
obj An object whose field to get and set
return
the previous value

        for (;;) {
            int current = get(obj);
            int next = current - 1;
            if (compareAndSet(obj, current, next))
                return current;
        }
    
public intgetAndIncrement(T obj)
Atomically increments by one the current value of the field of the given object managed by this updater.

param
obj An object whose field to get and set
return
the previous value

        for (;;) {
            int current = get(obj);
            int next = current + 1;
            if (compareAndSet(obj, current, next))
                return current;
        }
    
public intgetAndSet(T obj, int newValue)
Atomically sets the field of the given object managed by this updater to the given value and returns the old value.

param
obj An object whose field to get and set
param
newValue the new value
return
the previous value

        for (;;) {
            int current = get(obj);
            if (compareAndSet(obj, current, newValue))
                return current;
        }
    
public intincrementAndGet(T obj)
Atomically increments by one the current value of the field of the given object managed by this updater.

param
obj An object whose field to get and set
return
the updated value

        for (;;) {
            int current = get(obj);
            int next = current + 1;
            if (compareAndSet(obj, current, next))
                return next;
        }
    
public abstract voidlazySet(T obj, int newValue)
Eventually sets the field of the given object managed by this updater to the given updated value.

param
obj An object whose field to set
param
newValue the new value
since
1.6

public static java.util.concurrent.atomic.AtomicIntegerFieldUpdaternewUpdater(java.lang.Class tclass, java.lang.String fieldName)
Creates and returns an updater for objects with the given field. The Class argument is needed to check that reflective types and generic types match.

param
tclass the class of the objects holding the field
param
fieldName the name of the field to be updated
return
the updater
throws
IllegalArgumentException if the field is not a volatile integer type
throws
RuntimeException with a nested reflection-based exception if the class does not hold field or is the wrong type

        return new AtomicIntegerFieldUpdaterImpl<U>(tclass, fieldName);
    
public abstract voidset(T obj, int 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}.

param
obj An object whose field to set
param
newValue the new value

public abstract booleanweakCompareAndSet(T obj, int expect, int 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}.

param
obj An object whose field to conditionally set
param
expect the expected value
param
update the new value
return
true if successful
throws
ClassCastException if {@code obj} is not an instance of the class possessing the field established in the constructor