compareAndSetAt

kotlin-stdlib/kotlin.concurrent.atomics/AtomicArray/compareAndSetAt

Платформы и требования к версиям: Common (2.1), Native (2.1)

expect fun compareAndSetAt(index: Int, expectedValue: T, newValue: T): Boolean

Атомарно записывает новое значение в элемент этого AtomicArray по указанному индексу, если текущее значение равно ожидаемому значению. Возвращает true, если операция выполнена успешно, и false только в том случае, если текущее значение элемента не равно ожидаемому значению.

Эта операция имеет так называемую строгую семантику: она возвращает false тогда и только тогда, когда текущее и ожидаемое значения не равны.

Сравнение значений выполняется по ссылке.

Исключения

IndexOutOfBoundsException

если индекс выходит за границы этого массива.

Примеры

import kotlin.concurrent.atomics.*
import kotlin.concurrent.atomics.AtomicArray
import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   val a = AtomicArray(arrayOf("aaa", "bbb", "ccc"))
// Current value of a[1] is "bbb", it is equal to the expected value "bbb" -> compareAndSetAt succeeds.
println(a.compareAndSetAt(index = 1, expectedValue = "bbb", newValue = "kkk")) // true
println(a.loadAt(1)) // kkk
println(a.toString()) // [aaa, kkk, ccc]

// Current value of a[2] is "ccc", it is not equal to the expected value "aaa" -> compareAndSetAt fails.
println(a.compareAndSetAt(index = 2, expectedValue = "aaa", newValue = "jjj")) // false
println(a.loadAt(2)) // ccc
println(a.toString()) // [aaa, kkk, ccc] 
   //sampleEnd
}

Платформы и требования к версиям: JS (2.1), Wasm-JS (2.1), Wasm-WASI (2.1)

actual fun compareAndSetAt(index: Int, expectedValue: T, newValue: T): Boolean

Сравнение значений выполняется по ссылке.

Исключения

IndexOutOfBoundsException

если индекс выходит за границы этого массива.

Примеры

import kotlin.concurrent.atomics.*
import kotlin.concurrent.atomics.AtomicArray
import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   val a = AtomicArray(arrayOf("aaa", "bbb", "ccc"))
// Current value of a[1] is "bbb", it is equal to the expected value "bbb" -> compareAndSetAt succeeds.
println(a.compareAndSetAt(index = 1, expectedValue = "bbb", newValue = "kkk")) // true
println(a.loadAt(1)) // kkk
println(a.toString()) // [aaa, kkk, ccc]

// Current value of a[2] is "ccc", it is not equal to the expected value "aaa" -> compareAndSetAt fails.
println(a.compareAndSetAt(index = 2, expectedValue = "aaa", newValue = "jjj")) // false
println(a.loadAt(2)) // ccc
println(a.toString()) // [aaa, kkk, ccc] 
   //sampleEnd
}

Платформы и требования к версиям: JVM (2.1)

actual fun compareAndSetAt(index: Int, expectedValue: T, newValue: T): Boolean

Сравнение значений выполняется по ссылке.

Имеет те же эффекты для памяти, что и java.util.concurrent.atomic.AtomicReferenceArray.compareAndSet.

Исключения

IndexOutOfBoundsException

если индекс выходит за границы этого массива.

Примеры

import kotlin.concurrent.atomics.*
import kotlin.concurrent.atomics.AtomicArray
import kotlin.test.assertFailsWith

fun main() { 
   //sampleStart 
   val a = AtomicArray(arrayOf("aaa", "bbb", "ccc"))
// Current value of a[1] is "bbb", it is equal to the expected value "bbb" -> compareAndSetAt succeeds.
println(a.compareAndSetAt(index = 1, expectedValue = "bbb", newValue = "kkk")) // true
println(a.loadAt(1)) // kkk
println(a.toString()) // [aaa, kkk, ccc]

// Current value of a[2] is "ccc", it is not equal to the expected value "aaa" -> compareAndSetAt fails.
println(a.compareAndSetAt(index = 2, expectedValue = "aaa", newValue = "jjj")) // false
println(a.loadAt(2)) // ccc
println(a.toString()) // [aaa, kkk, ccc] 
   //sampleEnd
}

© 2010–2026 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.concurrent.atomics/-atomic-array/compare-and-set-at.html