Class Overview
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.
Summary
| Public Constructors |
|---|
|
|
AtomicLong(long initialValue)
Create a new AtomicLong with the given initial value.
|
|
|
AtomicLong()
Create a new AtomicLong with initial value 0.
|
| Public Methods |
|---|
|
final
long
|
addAndGet(long delta)
Atomically add the given value to current value.
|
|
final
boolean
|
compareAndSet(long expect, long update)
Atomically set the value to the given updated value
if the current value == the expected value.
|
|
final
long
|
decrementAndGet()
Atomically decrement by one the current value.
|
|
double
|
doubleValue()
Returns this object's value as a double.
|
|
float
|
floatValue()
Returns this object's value as a float.
|
|
final
long
|
get()
Get the current value.
|
|
final
long
|
getAndAdd(long delta)
Atomically add the given value to current value.
|
|
final
long
|
getAndDecrement()
Atomically decrement by one the current value.
|
|
final
long
|
getAndIncrement()
Atomically increment by one the current value.
|
|
final
long
|
getAndSet(long newValue)
Set to the give value and return the old value.
|
|
final
long
|
incrementAndGet()
Atomically increment by one the current value.
|
|
int
|
intValue()
Returns this object's value as an int.
|
|
long
|
longValue()
Returns this object's value as a long.
|
|
final
void
|
set(long newValue)
Set to the given value.
|
|
String
|
toString()
Returns the String representation of the current value.
|
|
final
boolean
|
weakCompareAndSet(long expect, long update)
Atomically set the value to the given updated value
if the current value == the expected value.
|
|
[Expand]
Inherited Methods |
|---|
From class java.lang.Number
|
byte
|
byteValue()
Returns this object's value as a byte.
|
|
abstract
double
|
doubleValue()
Returns this object's value as a double.
|
|
abstract
float
|
floatValue()
Returns this object's value as a float.
|
|
abstract
int
|
intValue()
Returns this object's value as an int.
|
|
abstract
long
|
longValue()
Returns this object's value as a long.
|
|
short
|
shortValue()
Returns this object's value as a short.
|
|
From class java.lang.Object
|
Object
|
clone()
Creates and returns a copy of this Object.
|
|
boolean
|
equals(Object o)
Compares this instance with the specified object and indicates if they
are equal.
|
|
void
|
finalize()
Is called before the object's memory is being reclaimed by the VM.
|
|
final
Class<? extends Object>
|
getClass()
Returns the unique instance of Class which represents this
object's class. |
|
int
|
hashCode()
Returns an integer hash code for this object.
|
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
|
final
void
|
wait(long millis, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait(long millis)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
|
Public Constructors
public
AtomicLong
(long initialValue)
Create a new AtomicLong with the given initial value.
Parameters
| initialValue
| the initial value
|
public
AtomicLong
()
Create a new AtomicLong with initial value 0.
Public Methods
public
final
long
addAndGet
(long delta)
Atomically add the given value to current value.
public
final
boolean
compareAndSet
(long expect, long update)
Atomically set the value to the given updated value
if the current value == the expected value.
Parameters
| expect
| the expected value |
| update
| the new value |
Returns
- true if successful. False return indicates that
the actual value was not equal to the expected value.
public
final
long
decrementAndGet
()
Atomically decrement by one the current value.
public
double
doubleValue
()
Returns this object's value as a double. Might involve rounding.
Returns
- the primitive double value of this object.
public
float
floatValue
()
Returns this object's value as a float. Might involve rounding.
Returns
- the primitive float value of this object.
public
final
long
getAndAdd
(long delta)
Atomically add the given value to current value.
public
final
long
getAndDecrement
()
Atomically decrement by one the current value.
public
final
long
getAndIncrement
()
Atomically increment by one the current value.
public
final
long
getAndSet
(long newValue)
Set to the give value and return the old value.
public
final
long
incrementAndGet
()
Atomically increment by one the current value.
public
int
intValue
()
Returns this object's value as an int. Might involve rounding and/or
truncating the value, so it fits into an int.
Returns
- the primitive int value of this object.
public
long
longValue
()
Returns this object's value as a long. Might involve rounding and/or
truncating the value, so it fits into a long.
Returns
- the primitive long value of this object.
public
final
void
set
(long newValue)
public
String
toString
()
Returns the String representation of the current value.
Returns
- the String representation of the current value.
public
final
boolean
weakCompareAndSet
(long expect, long update)
Atomically set the value to the given updated value
if the current value == the expected value.
May fail spuriously.
Parameters
| expect
| the expected value |
| update
| the new value |
