AtomicLong
open class AtomicLong : Number, Serializable
kotlin.Any | ||
↳ | kotlin.Number | |
↳ | java.util.concurrent.atomic.AtomicLong |
A long
value that may be updated atomically. See the VarHandle
specification for descriptions of the properties of atomic accesses. An AtomicLong
is used in applications such as atomically incremented sequence numbers, and cannot be used as a replacement for a java.lang.Long
. However, this class does extend Number
to allow uniform access by tools and utilities that deal with numerically-based classes.
Summary
Public constructors | |
---|---|
AtomicLong(initialValue: Long) Creates a new AtomicLong with the given initial value. |
|
Creates a new AtomicLong with initial value |
Public methods | |
---|---|
Long |
accumulateAndGet(x: Long, accumulatorFunction: LongBinaryOperator!) Atomically updates (with memory effects as specified by |
Long |
Atomically adds the given value to the current value, with memory effects as specified by |
Long |
compareAndExchange(expectedValue: Long, newValue: Long) Atomically sets the value to |
Long |
compareAndExchangeAcquire(expectedValue: Long, newValue: Long) Atomically sets the value to |
Long |
compareAndExchangeRelease(expectedValue: Long, newValue: Long) Atomically sets the value to |
Boolean |
compareAndSet(expectedValue: Long, newValue: Long) Atomically sets the value to |
Long |
Atomically decrements the current value, with memory effects as specified by |
Long |
get() Returns the current value, with memory effects as specified by |
Long |
Returns the current value, with memory effects as specified by |
Long |
getAndAccumulate(x: Long, accumulatorFunction: LongBinaryOperator!) Atomically updates (with memory effects as specified by |
Long |
Atomically adds the given value to the current value, with memory effects as specified by |
Long |
Atomically decrements the current value, with memory effects as specified by |
Long |
Atomically increments the current value, with memory effects as specified by |
Long |
Atomically sets the value to |
Long |
getAndUpdate(updateFunction: LongUnaryOperator!) Atomically updates (with memory effects as specified by |
Long |
Returns the current value, with memory effects as specified by |
Long |
getPlain() Returns the current value, with memory semantics of reading as if the variable was declared non- |
Long |
Atomically increments the current value, with memory effects as specified by |
Unit |
Sets the value to |
Unit |
Sets the value to |
Unit |
Sets the value to |
Unit |
Sets the value to |
Unit |
setRelease(newValue: Long) Sets the value to |
open Double |
toDouble() Returns the current value of this |
open Float |
toFloat() Returns the current value of this |
open Int |
toInt() Returns the current value of this |
open Long |
toLong() Returns the current value of this |
open String |
toString() Returns the String representation of the current value. |
Long |
updateAndGet(updateFunction: LongUnaryOperator!) Atomically updates (with memory effects as specified by |
Boolean |
weakCompareAndSet(expectedValue: Long, newValue: Long) Possibly atomically sets the value to |
Boolean |
weakCompareAndSetAcquire(expectedValue: Long, newValue: Long) Possibly atomically sets the value to |
Boolean |
weakCompareAndSetPlain(expectedValue: Long, newValue: Long) Possibly atomically sets the value to |
Boolean |
weakCompareAndSetRelease(expectedValue: Long, newValue: Long) Possibly atomically sets the value to |
Boolean |
weakCompareAndSetVolatile(expectedValue: Long, newValue: Long) Possibly atomically sets the value to |
Public constructors
AtomicLong
AtomicLong(initialValue: Long)
Creates a new AtomicLong with the given initial value.
Parameters | |
---|---|
initialValue |
Long: the initial value |
Public methods
accumulateAndGet
fun accumulateAndGet(
x: Long,
accumulatorFunction: LongBinaryOperator!
): Long
Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet
) the current value 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 | |
---|---|
x |
Long: the update value |
accumulatorFunction |
LongBinaryOperator!: a side-effect-free function of two arguments |
Return | |
---|---|
Long |
the updated value |
addAndGet
fun addAndGet(delta: Long): Long
Atomically adds the given value to the current value, with memory effects as specified by VarHandle#getAndAdd
.
Parameters | |
---|---|
delta |
Long: the value to add |
Return | |
---|---|
Long |
the updated value |
compareAndExchange
fun compareAndExchange(
expectedValue: Long,
newValue: Long
): Long
Atomically sets the value to newValue
if the current value, referred to as the witness value, == expectedValue
, with memory effects as specified by VarHandle#compareAndExchange
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Long |
the witness value, which will be the same as the expected value if successful |
compareAndExchangeAcquire
fun compareAndExchangeAcquire(
expectedValue: Long,
newValue: Long
): Long
Atomically sets the value to newValue
if the current value, referred to as the witness value, == expectedValue
, with memory effects as specified by VarHandle#compareAndExchangeAcquire
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Long |
the witness value, which will be the same as the expected value if successful |
compareAndExchangeRelease
fun compareAndExchangeRelease(
expectedValue: Long,
newValue: Long
): Long
Atomically sets the value to newValue
if the current value, referred to as the witness value, == expectedValue
, with memory effects as specified by VarHandle#compareAndExchangeRelease
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Long |
the witness value, which will be the same as the expected value if successful |
compareAndSet
fun compareAndSet(
expectedValue: Long,
newValue: Long
): Boolean
Atomically sets the value to newValue
if the current value == expectedValue
, with memory effects as specified by VarHandle#compareAndSet
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Boolean |
true if successful. False return indicates that the actual value was not equal to the expected value. |
decrementAndGet
fun decrementAndGet(): Long
Atomically decrements the current value, with memory effects as specified by VarHandle#getAndAdd
.
Equivalent to addAndGet(-1)
.
Return | |
---|---|
Long |
the updated value |
get
fun get(): Long
Returns the current value, with memory effects as specified by VarHandle#getVolatile
.
Return | |
---|---|
Long |
the current value |
getAcquire
fun getAcquire(): Long
Returns the current value, with memory effects as specified by VarHandle#getAcquire
.
Return | |
---|---|
Long |
the value |
getAndAccumulate
fun getAndAccumulate(
x: Long,
accumulatorFunction: LongBinaryOperator!
): Long
Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet
) the current value 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 | |
---|---|
x |
Long: the update value |
accumulatorFunction |
LongBinaryOperator!: a side-effect-free function of two arguments |
Return | |
---|---|
Long |
the previous value |
getAndAdd
fun getAndAdd(delta: Long): Long
Atomically adds the given value to the current value, with memory effects as specified by VarHandle#getAndAdd
.
Parameters | |
---|---|
delta |
Long: the value to add |
Return | |
---|---|
Long |
the previous value |
getAndDecrement
fun getAndDecrement(): Long
Atomically decrements the current value, with memory effects as specified by VarHandle#getAndAdd
.
Equivalent to getAndAdd(-1)
.
Return | |
---|---|
Long |
the previous value |
getAndIncrement
fun getAndIncrement(): Long
Atomically increments the current value, with memory effects as specified by VarHandle#getAndAdd
.
Equivalent to getAndAdd(1)
.
Return | |
---|---|
Long |
the previous value |
getAndSet
fun getAndSet(newValue: Long): Long
Atomically sets the value to newValue
and returns the old value, with memory effects as specified by VarHandle#getAndSet
.
Parameters | |
---|---|
newValue |
Long: the new value |
Return | |
---|---|
Long |
the previous value |
getAndUpdate
fun getAndUpdate(updateFunction: LongUnaryOperator!): Long
Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet
) the current value 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 | |
---|---|
updateFunction |
LongUnaryOperator!: a side-effect-free function |
Return | |
---|---|
Long |
the previous value |
getOpaque
fun getOpaque(): Long
Returns the current value, with memory effects as specified by VarHandle#getOpaque
.
Return | |
---|---|
Long |
the value |
getPlain
fun getPlain(): Long
Returns the current value, with memory semantics of reading as if the variable was declared non-volatile
.
Return | |
---|---|
Long |
the value |
incrementAndGet
fun incrementAndGet(): Long
Atomically increments the current value, with memory effects as specified by VarHandle#getAndAdd
.
Equivalent to addAndGet(1)
.
Return | |
---|---|
Long |
the updated value |
lazySet
fun lazySet(newValue: Long): Unit
Sets the value to newValue
, with memory effects as specified by VarHandle#setRelease
.
Parameters | |
---|---|
newValue |
Long: the new value |
set
fun set(newValue: Long): Unit
Sets the value to newValue
, with memory effects as specified by VarHandle#setVolatile
.
Parameters | |
---|---|
newValue |
Long: the new value |
setOpaque
fun setOpaque(newValue: Long): Unit
Sets the value to newValue
, with memory effects as specified by VarHandle#setOpaque
.
Parameters | |
---|---|
newValue |
Long: the new value |
setPlain
fun setPlain(newValue: Long): Unit
Sets the value to newValue
, with memory semantics of setting as if the variable was declared non-volatile
and non-final
.
Parameters | |
---|---|
newValue |
Long: the new value |
setRelease
fun setRelease(newValue: Long): Unit
Sets the value to newValue
, with memory effects as specified by VarHandle#setRelease
.
Parameters | |
---|---|
newValue |
Long: the new value |
toDouble
open fun toDouble(): Double
Returns the current value of this AtomicLong
as a double
after a widening primitive conversion, with memory effects as specified by VarHandle#getVolatile
.
Return | |
---|---|
Double |
the numeric value represented by this object after conversion to type double . |
toFloat
open fun toFloat(): Float
Returns the current value of this AtomicLong
as a float
after a widening primitive conversion, with memory effects as specified by VarHandle#getVolatile
.
Return | |
---|---|
Float |
the numeric value represented by this object after conversion to type float . |
toInt
open fun toInt(): Int
Returns the current value of this AtomicLong
as an int
after a narrowing primitive conversion, with memory effects as specified by VarHandle#getVolatile
.
Return | |
---|---|
Int |
the numeric value represented by this object after conversion to type int . |
toLong
open fun toLong(): Long
Returns the current value of this AtomicLong
as a long
, with memory effects as specified by VarHandle#getVolatile
. Equivalent to get()
.
Return | |
---|---|
Long |
the numeric value represented by this object after conversion to type long . |
toString
open fun toString(): String
Returns the String representation of the current value.
Return | |
---|---|
String |
the String representation of the current value |
updateAndGet
fun updateAndGet(updateFunction: LongUnaryOperator!): Long
Atomically updates (with memory effects as specified by java.lang.invoke.VarHandle#compareAndSet
) the current value 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 | |
---|---|
updateFunction |
LongUnaryOperator!: a side-effect-free function |
Return | |
---|---|
Long |
the updated value |
weakCompareAndSet
funweakCompareAndSet(
expectedValue: Long,
newValue: Long
): Boolean
Deprecated: This method has plain memory effects but the method name implies volatile memory effects (see methods such as compareAndExchange
and compareAndSet
). To avoid confusion over plain or volatile memory effects it is recommended that the method weakCompareAndSetPlain
be used instead.
Possibly atomically sets the value to newValue
if the current value == expectedValue
, with memory effects as specified by VarHandle#weakCompareAndSetPlain
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Boolean |
true if successful |
See Also
weakCompareAndSetAcquire
fun weakCompareAndSetAcquire(
expectedValue: Long,
newValue: Long
): Boolean
Possibly atomically sets the value to newValue
if the current value == expectedValue
, with memory effects as specified by VarHandle#weakCompareAndSetAcquire
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Boolean |
true if successful |
weakCompareAndSetPlain
fun weakCompareAndSetPlain(
expectedValue: Long,
newValue: Long
): Boolean
Possibly atomically sets the value to newValue
if the current value == expectedValue
, with memory effects as specified by VarHandle#weakCompareAndSetPlain
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Boolean |
true if successful |
weakCompareAndSetRelease
fun weakCompareAndSetRelease(
expectedValue: Long,
newValue: Long
): Boolean
Possibly atomically sets the value to newValue
if the current value == expectedValue
, with memory effects as specified by VarHandle#weakCompareAndSetRelease
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Boolean |
true if successful |
weakCompareAndSetVolatile
fun weakCompareAndSetVolatile(
expectedValue: Long,
newValue: Long
): Boolean
Possibly atomically sets the value to newValue
if the current value == expectedValue
, with memory effects as specified by VarHandle#weakCompareAndSet
.
Parameters | |
---|---|
expectedValue |
Long: the expected value |
newValue |
Long: the new value |
Return | |
---|---|
Boolean |
true if successful |