public
class
AtomicLong
extends Number
implements
Serializable
java.lang.Object | ||
↳ | java.lang.Number | |
↳ | java.util.concurrent.atomic.AtomicLong |
A long
value that may be updated atomically. See the
java.util.concurrent.atomic
package specification for
description of the properties of atomic variables. An
AtomicLong
is used in applications such as atomically
incremented sequence numbers, and cannot be used as a replacement
for a Long
. However, this class does extend
Number
to allow uniform access by tools and utilities that
deal with numerically-based classes.
Public constructors | |
---|---|
AtomicLong(long initialValue)
Creates a new AtomicLong with the given initial value. |
|
AtomicLong()
Creates a new AtomicLong with initial value |
Public methods | |
---|---|
final
long
|
accumulateAndGet(long x, LongBinaryOperator accumulatorFunction)
Atomically updates the current value with the results of applying the given function to the current and given values, returning the updated value. |
final
long
|
addAndGet(long delta)
Atomically adds the given value to the current value. |
final
boolean
|
compareAndSet(long expect, long update)
Atomically sets the value to the given updated value
if the current value |
final
long
|
decrementAndGet()
Atomically decrements by one the current value. |
double
|
doubleValue()
Returns the value of this |
float
|
floatValue()
Returns the value of this |
final
long
|
get()
Gets the current value. |
final
long
|
getAndAccumulate(long x, LongBinaryOperator accumulatorFunction)
Atomically updates the current value with the results of applying the given function to the current and given values, returning the previous value. |
final
long
|
getAndAdd(long delta)
Atomically adds the given value to the current value. |
final
long
|
getAndDecrement()
Atomically decrements by one the current value. |
final
long
|
getAndIncrement()
Atomically increments by one the current value. |
final
long
|
getAndSet(long newValue)
Atomically sets to the given value and returns the old value. |
final
long
|
getAndUpdate(LongUnaryOperator updateFunction)
Atomically updates the current value with the results of applying the given function, returning the previous value. |
final
long
|
incrementAndGet()
Atomically increments by one the current value. |
int
|
intValue()
Returns the value of this |
final
void
|
lazySet(long newValue)
Eventually sets to the given value. |
long
|
longValue()
Returns the value of this |
final
void
|
set(long newValue)
Sets to the given value. |
String
|
toString()
Returns the String representation of the current value. |
final
long
|
updateAndGet(LongUnaryOperator updateFunction)
Atomically updates the current value with the results of applying the given function, returning the updated value. |
final
boolean
|
weakCompareAndSet(long expect, long update)
Atomically sets the value to the given updated value
if the current value |
Inherited methods | |
---|---|
From
class
java.lang.Number
| |
From
class
java.lang.Object
|
AtomicLong (long initialValue)
Creates a new AtomicLong with the given initial value.
Parameters | |
---|---|
initialValue |
long :
the initial value
|
long accumulateAndGet (long x, LongBinaryOperator accumulatorFunction)
Atomically updates 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 |
Returns | |
---|---|
long |
the updated value |
long addAndGet (long delta)
Atomically adds the given value to the current value.
Parameters | |
---|---|
delta |
long :
the value to add |
Returns | |
---|---|
long |
the updated value |
boolean compareAndSet (long expect, long update)
Atomically sets the value to the given updated value
if the current value ==
the expected value.
Parameters | |
---|---|
expect |
long :
the expected value |
update |
long :
the new value |
Returns | |
---|---|
boolean |
true if successful. False return indicates that
the actual value was not equal to the expected value.
|
long decrementAndGet ()
Atomically decrements by one the current value.
Returns | |
---|---|
long |
the updated value |
double doubleValue ()
Returns the value of this AtomicLong
as a double
after a widening primitive conversion.
Returns | |
---|---|
double |
the numeric value represented by this object after conversion
to type double .
|
float floatValue ()
Returns the value of this AtomicLong
as a float
after a widening primitive conversion.
Returns | |
---|---|
float |
the numeric value represented by this object after conversion
to type float .
|
long getAndAccumulate (long x, LongBinaryOperator accumulatorFunction)
Atomically updates 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 |
Returns | |
---|---|
long |
the previous value |
long getAndAdd (long delta)
Atomically adds the given value to the current value.
Parameters | |
---|---|
delta |
long :
the value to add |
Returns | |
---|---|
long |
the previous value |
long getAndDecrement ()
Atomically decrements by one the current value.
Returns | |
---|---|
long |
the previous value |
long getAndIncrement ()
Atomically increments by one the current value.
Returns | |
---|---|
long |
the previous value |
long getAndSet (long newValue)
Atomically sets to the given value and returns the old value.
Parameters | |
---|---|
newValue |
long :
the new value |
Returns | |
---|---|
long |
the previous value |
long getAndUpdate (LongUnaryOperator updateFunction)
Atomically updates 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 |
Returns | |
---|---|
long |
the previous value |
long incrementAndGet ()
Atomically increments by one the current value.
Returns | |
---|---|
long |
the updated value |
int intValue ()
Returns the value of this AtomicLong
as an int
after a narrowing primitive conversion.
Returns | |
---|---|
int |
the numeric value represented by this object after conversion
to type int .
|
void lazySet (long newValue)
Eventually sets to the given value.
Parameters | |
---|---|
newValue |
long :
the new value |
long longValue ()
Returns the value of this AtomicLong
as a long
.
Equivalent to get()
.
Returns | |
---|---|
long |
the numeric value represented by this object after conversion
to type long .
|
void set (long newValue)
Sets to the given value.
Parameters | |
---|---|
newValue |
long :
the new value
|
String toString ()
Returns the String representation of the current value.
Returns | |
---|---|
String |
the String representation of the current value |
long updateAndGet (LongUnaryOperator updateFunction)
Atomically updates 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 |
Returns | |
---|---|
long |
the updated value |
boolean weakCompareAndSet (long expect, long update)
Atomically sets the value 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 | |
---|---|
expect |
long :
the expected value |
update |
long :
the new value |
Returns | |
---|---|
boolean |
true if successful
|