- java.lang.Object
- 
- java.util.concurrent.atomic.AtomicIntegerFieldUpdater<T>
 
- 
- Type Parameters:
- T- The type of the object holding the updatable field
 
 public abstract class AtomicIntegerFieldUpdater<T> extends Object A reflection-based utility that enables atomic updates to designatedvolatile intfields 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 compareAndSetmethod 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 ofcompareAndSetandseton the same updater.Object arguments for parameters of type Tthat are not instances of the class passed tonewUpdater(java.lang.Class<U>, java.lang.String)will result in aClassCastExceptionbeing thrown.- Since:
- 1.5
 
- 
- 
Constructor SummaryConstructors Modifier Constructor Description protectedAtomicIntegerFieldUpdater()Protected do-nothing constructor for use by subclasses.
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description intaccumulateAndGet(T obj, int x, IntBinaryOperator accumulatorFunction)Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the updated value.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.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==the expected value.intdecrementAndGet(T obj)Atomically decrements by one the current value of the field of the given object managed by this updater.abstract intget(T obj)Returns the current value held in the field of the given object managed by this updater.intgetAndAccumulate(T obj, int x, IntBinaryOperator accumulatorFunction)Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the previous value.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.intgetAndDecrement(T obj)Atomically decrements by one the current value of the field of the given object managed by this updater.intgetAndIncrement(T obj)Atomically increments by one the current value of the field of the given object managed by this updater.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.intgetAndUpdate(T obj, IntUnaryOperator updateFunction)Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function, returning the previous value.intincrementAndGet(T obj)Atomically increments by one the current value of the field of the given object managed by this updater.abstract voidlazySet(T obj, int newValue)Eventually sets the field of the given object managed by this updater to the given updated value.static <U> AtomicIntegerFieldUpdater<U>newUpdater(Class<U> tclass, String fieldName)Creates and returns an updater for objects with the given field.abstract voidset(T obj, int newValue)Sets the field of the given object managed by this updater to the given updated value.intupdateAndGet(T obj, IntUnaryOperator updateFunction)Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function, returning the updated value.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==the expected value.
 
- 
- 
- 
Method Detail- 
newUpdaterpublic static <U> AtomicIntegerFieldUpdater<U> newUpdater(Class<U> tclass, 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.- Type Parameters:
- U- the type of instances of tclass
- Parameters:
- tclass- the class of the objects holding the field
- fieldName- the name of the field to be updated
- Returns:
- the updater
- Throws:
- IllegalArgumentException- if the field is not a volatile integer type
- RuntimeException- with a nested reflection-based exception if the class does not hold field or is the wrong type, or the field is inaccessible to the caller according to Java language access control
 
 - 
compareAndSetpublic abstract boolean compareAndSet(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==the expected value. This method is guaranteed to be atomic with respect to other calls tocompareAndSetandset, but not necessarily with respect to other changes in the field.- Parameters:
- obj- An object whose field to conditionally set
- expect- the expected value
- update- the new value
- Returns:
- trueif successful
 
 - 
weakCompareAndSetpublic abstract boolean weakCompareAndSet(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==the expected value. This method is guaranteed to be atomic with respect to other calls tocompareAndSetandset, 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 compareAndSet.- Parameters:
- obj- An object whose field to conditionally set
- expect- the expected value
- update- the new value
- Returns:
- trueif successful
 
 - 
setpublic abstract void set(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 ofcompareAndSet.- Parameters:
- obj- An object whose field to set
- newValue- the new value
 
 - 
lazySetpublic abstract void lazySet(T obj, int newValue) Eventually sets the field of the given object managed by this updater to the given updated value.- Parameters:
- obj- An object whose field to set
- newValue- the new value
- Since:
- 1.6
 
 - 
getpublic abstract int get(T obj) Returns the current value held in the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get
- Returns:
- the current value
 
 - 
getAndSetpublic int getAndSet(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.- Parameters:
- obj- An object whose field to get and set
- newValue- the new value
- Returns:
- the previous value
 
 - 
getAndIncrementpublic int getAndIncrement(T obj) Atomically increments by one the current value of the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get and set
- Returns:
- the previous value
 
 - 
getAndDecrementpublic int getAndDecrement(T obj) Atomically decrements by one the current value of the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get and set
- Returns:
- the previous value
 
 - 
getAndAddpublic int getAndAdd(T obj, int delta) Atomically adds the given value to the current value of the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get and set
- delta- the value to add
- Returns:
- the previous value
 
 - 
incrementAndGetpublic int incrementAndGet(T obj) Atomically increments by one the current value of the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get and set
- Returns:
- the updated value
 
 - 
decrementAndGetpublic int decrementAndGet(T obj) Atomically decrements by one the current value of the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get and set
- Returns:
- the updated value
 
 - 
addAndGetpublic int addAndGet(T obj, int delta) Atomically adds the given value to the current value of the field of the given object managed by this updater.- Parameters:
- obj- An object whose field to get and set
- delta- the value to add
- Returns:
- the updated value
 
 - 
getAndUpdatepublic final int getAndUpdate(T obj, IntUnaryOperator updateFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.- Parameters:
- obj- An object whose field to get and set
- updateFunction- a side-effect-free function
- Returns:
- the previous value
- Since:
- 1.8
 
 - 
updateAndGetpublic final int updateAndGet(T obj, IntUnaryOperator updateFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads.- Parameters:
- obj- An object whose field to get and set
- updateFunction- a side-effect-free function
- Returns:
- the updated value
- Since:
- 1.8
 
 - 
getAndAccumulatepublic final int getAndAccumulate(T obj, int x, IntBinaryOperator accumulatorFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the previous value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.- Parameters:
- obj- An object whose field to get and set
- x- the update value
- accumulatorFunction- a side-effect-free function of two arguments
- Returns:
- the previous value
- Since:
- 1.8
 
 - 
accumulateAndGetpublic final int accumulateAndGet(T obj, int x, IntBinaryOperator accumulatorFunction) Atomically updates (with memory effects as specified byVarHandle.compareAndSet(java.lang.Object...)) the field of the given object managed by this updater with the results of applying the given function to the current and given values, returning the updated value. The function should be side-effect-free, since it may be re-applied when attempted updates fail due to contention among threads. The function is applied with the current value as its first argument, and the given update as the second argument.- Parameters:
- obj- An object whose field to get and set
- x- the update value
- accumulatorFunction- a side-effect-free function of two arguments
- Returns:
- the updated value
- Since:
- 1.8
 
 
- 
 
-