Added in API level 1

AtomicIntegerFieldUpdater

abstract class AtomicIntegerFieldUpdater<T : Any!>

kotlin.Any
↳	java.util.concurrent.atomic.AtomicIntegerFieldUpdater

A reflection-based utility that enables atomic updates to designated 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 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 compareAndSet and set on the same updater.

Object arguments for parameters of type T that are not instances of the class passed to newUpdater will result in a ClassCastException being thrown.

Summary

Protected constructors
`AtomicIntegerFieldUpdater()` Protected do-nothing constructor for use by subclasses.

Public methods
Int	`accumulateAndGet(obj: T, x: Int, accumulatorFunction: IntBinaryOperator!)` Atomically updates (with memory effects as specified by `java.lang.invoke.VarHandle#compareAndSet`) 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.
open Int	`addAndGet(obj: T, delta: Int)` Atomically adds the given value to the current value of the field of the given object managed by this updater.
abstract Boolean	`compareAndSet(obj: T, expect: Int, update: Int)` Atomically sets the field of the given object managed by this updater to the given updated value if the current value `==` the expected value.
open Int	`decrementAndGet(obj: T)` Atomically decrements by one the current value of the field of the given object managed by this updater.
abstract Int	`get(obj: T)` Returns the current value held in the field of the given object managed by this updater.
Int	`getAndAccumulate(obj: T, x: Int, accumulatorFunction: IntBinaryOperator!)` Atomically updates (with memory effects as specified by `java.lang.invoke.VarHandle#compareAndSet`) 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.
open Int	`getAndAdd(obj: T, delta: Int)` Atomically adds the given value to the current value of the field of the given object managed by this updater.
open Int	`getAndDecrement(obj: T)` Atomically decrements by one the current value of the field of the given object managed by this updater.
open Int	`getAndIncrement(obj: T)` Atomically increments by one the current value of the field of the given object managed by this updater.
open Int	`getAndSet(obj: T, newValue: Int)` Atomically sets the field of the given object managed by this updater to the given value and returns the old value.
Int	`getAndUpdate(obj: T, updateFunction: IntUnaryOperator!)` Atomically updates (with memory effects as specified by `java.lang.invoke.VarHandle#compareAndSet`) the field of the given object managed by this updater with the results of applying the given function, returning the previous value.
open Int	`incrementAndGet(obj: T)` Atomically increments by one the current value of the field of the given object managed by this updater.
abstract Unit	`lazySet(obj: T, newValue: Int)` Eventually sets the field of the given object managed by this updater to the given updated value.
open static AtomicIntegerFieldUpdater<U>!	`newUpdater(tclass: Class<U>!, fieldName: String!)` Creates and returns an updater for objects with the given field.
abstract Unit	`set(obj: T, newValue: Int)` Sets the field of the given object managed by this updater to the given updated value.
Int	`updateAndGet(obj: T, updateFunction: IntUnaryOperator!)` Atomically updates (with memory effects as specified by `java.lang.invoke.VarHandle#compareAndSet`) the field of the given object managed by this updater with the results of applying the given function, returning the updated value.
abstract Boolean	`weakCompareAndSet(obj: T, expect: Int, update: Int)` Atomically sets the field of the given object managed by this updater to the given updated value if the current value `==` the expected value.

Protected constructors

AtomicIntegerFieldUpdater

Added in API level 1

protected AtomicIntegerFieldUpdater()

Protected do-nothing constructor for use by subclasses.

Public methods

accumulateAndGet

Added in API level 24

fun accumulateAndGet(
    obj: T, 
    x: Int, 
    accumulatorFunction: IntBinaryOperator!
): Int

Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet) 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`	T: An object whose field to get and set
`x`	Int: the update value
`accumulatorFunction`	IntBinaryOperator!: a side-effect-free function of two arguments

Return
`Int`	the updated value

addAndGet

Added in API level 1

open fun addAndGet(
    obj: T, 
    delta: Int
): Int

Atomically adds the given value to the current value of the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get and set
`delta`	Int: the value to add

Return
`Int`	the updated value

compareAndSet

Added in API level 1

abstract fun compareAndSet(
    obj: T, 
    expect: Int, 
    update: Int
): Boolean

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 to compareAndSet and set, but not necessarily with respect to other changes in the field.

Parameters
`obj`	T: An object whose field to conditionally set
`expect`	Int: the expected value
`update`	Int: the new value

Return
`Boolean`	`true` if successful

decrementAndGet

Added in API level 1

open fun decrementAndGet(obj: T): Int

Atomically decrements by one the current value of the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get and set

Return
`Int`	the updated value

get

Added in API level 1

abstract fun get(obj: T): Int

Returns the current value held in the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get

Return
`Int`	the current value

getAndAccumulate

Added in API level 24

fun getAndAccumulate(
    obj: T, 
    x: Int, 
    accumulatorFunction: IntBinaryOperator!
): Int

Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet) 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`	T: An object whose field to get and set
`x`	Int: the update value
`accumulatorFunction`	IntBinaryOperator!: a side-effect-free function of two arguments

Return
`Int`	the previous value

getAndAdd

Added in API level 1

open fun getAndAdd(
    obj: T, 
    delta: Int
): Int

Atomically adds the given value to the current value of the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get and set
`delta`	Int: the value to add

Return
`Int`	the previous value

getAndDecrement

Added in API level 1

open fun getAndDecrement(obj: T): Int

Atomically decrements by one the current value of the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get and set

Return
`Int`	the previous value

getAndIncrement

Added in API level 1

open fun getAndIncrement(obj: T): Int

Atomically increments by one the current value of the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get and set

Return
`Int`	the previous value

getAndSet

Added in API level 1

open fun getAndSet(
    obj: T, 
    newValue: Int
): Int

Atomically sets the field of the given object managed by this updater to the given value and returns the old value.

Parameters
`obj`	T: An object whose field to get and set
`newValue`	Int: the new value

Return
`Int`	the previous value

getAndUpdate

Added in API level 24

fun getAndUpdate(
    obj: T, 
    updateFunction: IntUnaryOperator!
): Int

Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet) 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`	T: An object whose field to get and set
`updateFunction`	IntUnaryOperator!: a side-effect-free function

Return
`Int`	the previous value

incrementAndGet

Added in API level 1

open fun incrementAndGet(obj: T): Int

Atomically increments by one the current value of the field of the given object managed by this updater.

Parameters
`obj`	T: An object whose field to get and set

Return
`Int`	the updated value

lazySet

Added in API level 9

abstract fun lazySet(
    obj: T, 
    newValue: Int
): Unit

Eventually sets the field of the given object managed by this updater to the given updated value.

Parameters
`obj`	T: An object whose field to set
`newValue`	Int: the new value

newUpdater

Added in API level 1

open static fun <U : Any!> newUpdater(
    tclass: Class<U>!, 
    fieldName: String!
): AtomicIntegerFieldUpdater<U>!

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.

Parameters
`tclass`	Class<U>!: the class of the objects holding the field
`fieldName`	String!: the name of the field to be updated
`<U>`	the type of instances of tclass

Return
`AtomicIntegerFieldUpdater<U>!`	the updater

Exceptions
`java.lang.IllegalArgumentException`	if the field is not a volatile integer type
`java.lang.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

set

Added in API level 1

abstract fun set(
    obj: T, 
    newValue: Int
): Unit

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 compareAndSet.

Parameters
`obj`	T: An object whose field to set
`newValue`	Int: the new value

updateAndGet

Added in API level 24

fun updateAndGet(
    obj: T, 
    updateFunction: IntUnaryOperator!
): Int

Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet) 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`	T: An object whose field to get and set
`updateFunction`	IntUnaryOperator!: a side-effect-free function

Return
`Int`	the updated value

weakCompareAndSet

Added in API level 1

abstract fun weakCompareAndSet(
    obj: T, 
    expect: Int, 
    update: Int
): Boolean

This operation may fail spuriously and does not provide ordering guarantees, so is only rarely an appropriate alternative to compareAndSet.

Parameters
`obj`	T: An object whose field to conditionally set
`expect`	Int: the expected value
`update`	Int: the new value

Return
`Boolean`	`true` if successful