Added in API level 1

AtomicLongArray

open class AtomicLongArray : Serializable

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

A long 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 AtomicLongArray of the given length, with all elements initially zero.
`<init>(array: LongArray!)` Creates a new AtomicLongArray with the same length as, and all elements copied from, the given array.

Public methods
Long	`accumulateAndGet(i: Int, x: Long, accumulatorFunction: LongBinaryOperator!)` 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.
open Long	`addAndGet(i: Int, delta: Long)` Atomically adds the given value to the element at index `i`.
Boolean	`compareAndSet(i: Int, expect: Long, update: Long)` Atomically sets the element at position `i` to the given updated value if the current value `==` the expected value.
Long	`decrementAndGet(i: Int)` Atomically decrements by one the element at index `i`.
Long	`get(i: Int)` Gets the current value at position `i`.
Long	`getAndAccumulate(i: Int, x: Long, accumulatorFunction: LongBinaryOperator!)` 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.
Long	`getAndAdd(i: Int, delta: Long)` Atomically adds the given value to the element at index `i`.
Long	`getAndDecrement(i: Int)` Atomically decrements by one the element at index `i`.
Long	`getAndIncrement(i: Int)` Atomically increments by one the element at index `i`.
Long	`getAndSet(i: Int, newValue: Long)` Atomically sets the element at position `i` to the given value and returns the old value.
Long	`getAndUpdate(i: Int, updateFunction: LongUnaryOperator!)` Atomically updates the element at index `i` with the results of applying the given function, returning the previous value.
Long	`incrementAndGet(i: Int)` Atomically increments by one the element at index `i`.
Unit	`lazySet(i: Int, newValue: Long)` Eventually sets the element at position `i` to the given value.
Int	`length()` Returns the length of the array.
Unit	`set(i: Int, newValue: Long)` Sets the element at position `i` to the given value.
open String	`toString()` Returns the String representation of the current values of array.
Long	`updateAndGet(i: Int, updateFunction: LongUnaryOperator!)` Atomically updates the element at index `i` with the results of applying the given function, returning the updated value.
Boolean	`weakCompareAndSet(i: Int, expect: Long, update: Long)` 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

AtomicLongArray(length: Int)

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

Parameters
`length`	Int: the length of the array

<init>

Added in API level 1

AtomicLongArray(array: LongArray!)

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

Parameters
`array`	LongArray!: 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: Long, 
    accumulatorFunction: LongBinaryOperator!
): Long

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`	Long: the update value
`accumulatorFunction`	LongBinaryOperator!: a side-effect-free function of two arguments

Return
`Long`	the updated value

addAndGet

Added in API level 1

open fun addAndGet(
    i: Int, 
    delta: Long
): Long

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

Parameters
`i`	Int: the index
`delta`	Long: the value to add

Return
`Long`	the updated value

compareAndSet

Added in API level 1

fun compareAndSet(
    i: Int, 
    expect: Long, 
    update: Long
): 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`	Long: the expected value
`update`	Long: 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): Long

Atomically decrements by one the element at index i.

Parameters
`i`	Int: the index

Return
`Long`	the updated value

get

Added in API level 1

fun get(i: Int): Long

Gets the current value at position i.

Parameters
`i`	Int: the index

Return
`Long`	the current value

getAndAccumulate

Added in API level 24

fun getAndAccumulate(
    i: Int, 
    x: Long, 
    accumulatorFunction: LongBinaryOperator!
): Long

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`	Long: the update value
`accumulatorFunction`	LongBinaryOperator!: a side-effect-free function of two arguments

Return
`Long`	the previous value

getAndAdd

Added in API level 1

fun getAndAdd(
    i: Int, 
    delta: Long
): Long

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

Parameters
`i`	Int: the index
`delta`	Long: the value to add

Return
`Long`	the previous value

getAndDecrement

Added in API level 1

fun getAndDecrement(i: Int): Long

Atomically decrements by one the element at index i.

Parameters
`i`	Int: the index

Return
`Long`	the previous value

getAndIncrement

Added in API level 1

fun getAndIncrement(i: Int): Long

Atomically increments by one the element at index i.

Parameters
`i`	Int: the index

Return
`Long`	the previous value

getAndSet

Added in API level 1

fun getAndSet(
    i: Int, 
    newValue: Long
): Long

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

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

Return
`Long`	the previous value

getAndUpdate

Added in API level 24

fun getAndUpdate(
    i: Int, 
    updateFunction: LongUnaryOperator!
): Long

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`	LongUnaryOperator!: a side-effect-free function

Return
`Long`	the previous value

incrementAndGet

Added in API level 1

fun incrementAndGet(i: Int): Long

Atomically increments by one the element at index i.

Parameters
`i`	Int: the index

Return
`Long`	the updated value

lazySet

Added in API level 9

fun lazySet(
    i: Int, 
    newValue: Long
): Unit

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

Parameters
`i`	Int: the index
`newValue`	Long: 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: Long
): Unit

Sets the element at position i to the given value.

Parameters
`i`	Int: the index
`newValue`	Long: 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: LongUnaryOperator!
): Long

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`	LongUnaryOperator!: a side-effect-free function

Return
`Long`	the updated value

weakCompareAndSet

Added in API level 1

fun weakCompareAndSet(
    i: Int, 
    expect: Long, 
    update: Long
): 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`	Long: the expected value
`update`	Long: the new value

Return
`Boolean`	`true` if successful