Google is committed to advancing racial equity for Black communities. See how.
Added in API level 1

AtomicIntegerArray

open class AtomicIntegerArray : Serializable
kotlin.Any
   ↳ java.util.concurrent.atomic.AtomicIntegerArray

An int array in which elements may be updated atomically. See the java.util.concurrent.atomic package specification for description of the properties of atomic variables.

Summary

Public constructors
<init>(length: Int)

Creates a new AtomicIntegerArray of the given length, with all elements initially zero.
<init>(array: IntArray!)

Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.

Public methods
Int
accumulateAndGet(i: Int, x: Int, accumulatorFunction: IntBinaryOperator!)

Atomically updates the element at index i with the results of applying the given function to the current and given values, returning the updated value.
Int
addAndGet(i: Int, delta: Int)

Atomically adds the given value to the element at index i.
Boolean
compareAndSet(i: Int, expect: Int, update: Int)

Atomically sets the element at position i to the given updated value if the current value == the expected value.
Int

Atomically decrements by one the element at index i.
Int
get(i: Int)

Gets the current value at position i.
Int
getAndAccumulate(i: Int, x: Int, accumulatorFunction: IntBinaryOperator!)

Atomically updates the element at index i with the results of applying the given function to the current and given values, returning the previous value.
Int
getAndAdd(i: Int, delta: Int)

Atomically adds the given value to the element at index i.
Int

Atomically decrements by one the element at index i.
Int

Atomically increments by one the element at index i.
Int
getAndSet(i: Int, newValue: Int)

Atomically sets the element at position i to the given value and returns the old value.
Int
getAndUpdate(i: Int, updateFunction: IntUnaryOperator!)

Atomically updates the element at index i with the results of applying the given function, returning the previous value.
Int

Atomically increments by one the element at index i.
Unit
lazySet(i: Int, newValue: Int)

Eventually sets the element at position i to the given value.
Int

Returns the length of the array.
Unit
set(i: Int, newValue: Int)

Sets the element at position i to the given value.
open String

Returns the String representation of the current values of array.
Int
updateAndGet(i: Int, updateFunction: IntUnaryOperator!)

Atomically updates the element at index i with the results of applying the given function, returning the updated value.
Boolean
weakCompareAndSet(i: Int, expect: Int, update: Int)

Atomically sets the element at position i to the given updated value if the current value == the expected value.

Public constructors

<init>

Added in API level 1
AtomicIntegerArray(length: Int)

Creates a new AtomicIntegerArray of the given length, with all elements initially zero.

Parameters
length Int: the length of the array

<init>

Added in API level 1
AtomicIntegerArray(array: IntArray!)

Creates a new AtomicIntegerArray with the same length as, and all elements copied from, the given array.

Parameters
array IntArray!: the array to copy elements from
Exceptions
java.lang.NullPointerException if array is null

Public methods

accumulateAndGet

Added in API level 24
fun accumulateAndGet(
    i: Int, 
    x: Int, 
    accumulatorFunction: IntBinaryOperator!
): Int

Atomically updates the element at index i 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 at index i as its first argument, and the given update as the second argument.

Parameters
i Int: the index
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
fun addAndGet(
    i: Int, 
    delta: Int
): Int

Atomically adds the given value to the element at index i.

Parameters
i Int: the index
delta Int: the value to add
Return
Int the updated value

compareAndSet

Added in API level 1
fun compareAndSet(
    i: Int, 
    expect: Int, 
    update: Int
): Boolean

Atomically sets the element at position i to the given updated value if the current value == the expected value.

Parameters
i Int: the index
expect Int: the expected value
update Int: the new value
Return
Boolean true if successful. False return indicates that the actual value was not equal to the expected value.

decrementAndGet

Added in API level 1
fun decrementAndGet(i: Int): Int

Atomically decrements by one the element at index i.

Parameters
i Int: the index
Return
Int the updated value

get

Added in API level 1
fun get(i: Int): Int

Gets the current value at position i.

Parameters
i Int: the index
Return
Int the current value

getAndAccumulate

Added in API level 24
fun getAndAccumulate(
    i: Int, 
    x: Int, 
    accumulatorFunction: IntBinaryOperator!
): Int

Atomically updates the element at index i 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 at index i as its first argument, and the given update as the second argument.

Parameters
i Int: the index
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
fun getAndAdd(
    i: Int, 
    delta: Int
): Int

Atomically adds the given value to the element at index i.

Parameters
i Int: the index
delta Int: the value to add
Return
Int the previous value

getAndDecrement

Added in API level 1
fun getAndDecrement(i: Int): Int

Atomically decrements by one the element at index i.

Parameters
i Int: the index
Return
Int the previous value

getAndIncrement

Added in API level 1
fun getAndIncrement(i: Int): Int

Atomically increments by one the element at index i.

Parameters
i Int: the index
Return
Int the previous value

getAndSet

Added in API level 1
fun getAndSet(
    i: Int, 
    newValue: Int
): Int

Atomically sets the element at position i to the given value and returns the old value.

Parameters
i Int: the index
newValue Int: the new value
Return
Int the previous value

getAndUpdate

Added in API level 24
fun getAndUpdate(
    i: Int, 
    updateFunction: IntUnaryOperator!
): Int

Atomically updates the element at index i 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
i Int: the index
updateFunction IntUnaryOperator!: a side-effect-free function
Return
Int the previous value

incrementAndGet

Added in API level 1
fun incrementAndGet(i: Int): Int

Atomically increments by one the element at index i.

Parameters
i Int: the index
Return
Int the updated value

lazySet

Added in API level 9
fun lazySet(
    i: Int, 
    newValue: Int
): Unit

Eventually sets the element at position i to the given value.

Parameters
i Int: the index
newValue Int: the new value

length

Added in API level 1
fun length(): Int

Returns the length of the array.

Return
Int the length of the array

set

Added in API level 1
fun set(
    i: Int, 
    newValue: Int
): Unit

Sets the element at position i to the given value.

Parameters
i Int: the index
newValue Int: the new value

toString

Added in API level 1
open fun toString(): String

Returns the String representation of the current values of array.

Return
String the String representation of the current values of array

updateAndGet

Added in API level 24
fun updateAndGet(
    i: Int, 
    updateFunction: IntUnaryOperator!
): Int

Atomically updates the element at index i 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
i Int: the index
updateFunction IntUnaryOperator!: a side-effect-free function
Return
Int the updated value

weakCompareAndSet

Added in API level 1
fun weakCompareAndSet(
    i: Int, 
    expect: Int, 
    update: Int
): Boolean

Atomically sets the element at position i to the given updated value if the current value == the expected value.

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

Parameters
i Int: the index
expect Int: the expected value
update Int: the new value
Return
Boolean true if successful