- java.lang.Object
-
- java.lang.Number
-
- java.util.concurrent.atomic.AtomicLong
-
- All Implemented Interfaces:
- Serializable
public class AtomicLong extends Number implements Serializable
Along
value that may be updated atomically. See thejava.util.concurrent.atomic
package specification for description of the properties of atomic variables. AnAtomicLong
is used in applications such as atomically incremented sequence numbers, and cannot be used as a replacement for aLong
. However, this class does extendNumber
to allow uniform access by tools and utilities that deal with numerically-based classes.- Since:
- 1.5
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description AtomicLong()
Creates a new AtomicLong with initial value0
.AtomicLong(long initialValue)
Creates a new AtomicLong with the given initial value.
-
Method Summary
Methods Modifier and Type Method and Description long
addAndGet(long delta)
Atomically adds the given value to the current value.boolean
compareAndSet(long expect, long update)
Atomically sets the value to the given updated value if the current value==
the expected value.long
decrementAndGet()
Atomically decrements by one the current value.double
doubleValue()
Returns the value of the specified number as adouble
.float
floatValue()
Returns the value of the specified number as afloat
.long
get()
Gets the current value.long
getAndAdd(long delta)
Atomically adds the given value to the current value.long
getAndDecrement()
Atomically decrements by one the current value.long
getAndIncrement()
Atomically increments by one the current value.long
getAndSet(long newValue)
Atomically sets to the given value and returns the old value.long
incrementAndGet()
Atomically increments by one the current value.int
intValue()
Returns the value of the specified number as anint
.void
lazySet(long newValue)
Eventually sets to the given value.long
longValue()
Returns the value of the specified number as along
.void
set(long newValue)
Sets to the given value.String
toString()
Returns the String representation of the current value.boolean
weakCompareAndSet(long expect, long update)
Atomically sets the value to the given updated value if the current value==
the expected value.-
Methods inherited from class java.lang.Number
byteValue, shortValue
-
-
-
-
Constructor Detail
-
AtomicLong
public AtomicLong(long initialValue)
Creates a new AtomicLong with the given initial value.- Parameters:
initialValue
- the initial value
-
AtomicLong
public AtomicLong()
Creates a new AtomicLong with initial value0
.
-
-
Method Detail
-
get
public final long get()
Gets the current value.- Returns:
- the current value
-
set
public final void set(long newValue)
Sets to the given value.- Parameters:
newValue
- the new value
-
lazySet
public final void lazySet(long newValue)
Eventually sets to the given value.- Parameters:
newValue
- the new value- Since:
- 1.6
-
getAndSet
public final long getAndSet(long newValue)
Atomically sets to the given value and returns the old value.- Parameters:
newValue
- the new value- Returns:
- the previous value
-
compareAndSet
public final boolean compareAndSet(long expect, long update)
Atomically sets the value to the given updated value if the current value==
the expected value.- Parameters:
expect
- the expected valueupdate
- the new value- Returns:
- true if successful. False return indicates that the actual value was not equal to the expected value.
-
weakCompareAndSet
public final 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
- the expected valueupdate
- the new value- Returns:
- true if successful.
-
getAndIncrement
public final long getAndIncrement()
Atomically increments by one the current value.- Returns:
- the previous value
-
getAndDecrement
public final long getAndDecrement()
Atomically decrements by one the current value.- Returns:
- the previous value
-
getAndAdd
public final long getAndAdd(long delta)
Atomically adds the given value to the current value.- Parameters:
delta
- the value to add- Returns:
- the previous value
-
incrementAndGet
public final long incrementAndGet()
Atomically increments by one the current value.- Returns:
- the updated value
-
decrementAndGet
public final long decrementAndGet()
Atomically decrements by one the current value.- Returns:
- the updated value
-
addAndGet
public final long addAndGet(long delta)
Atomically adds the given value to the current value.- Parameters:
delta
- the value to add- Returns:
- the updated value
-
toString
public String toString()
Returns the String representation of the current value.
-
intValue
public int intValue()
Description copied from class:Number
Returns the value of the specified number as anint
. This may involve rounding or truncation.
-
longValue
public long longValue()
Description copied from class:Number
Returns the value of the specified number as along
. This may involve rounding or truncation.
-
floatValue
public float floatValue()
Description copied from class:Number
Returns the value of the specified number as afloat
. This may involve rounding.- Specified by:
floatValue
in classNumber
- Returns:
- the numeric value represented by this object after conversion
to type
float
.
-
doubleValue
public double doubleValue()
Description copied from class:Number
Returns the value of the specified number as adouble
. This may involve rounding.- Specified by:
doubleValue
in classNumber
- Returns:
- the numeric value represented by this object after conversion
to type
double
.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/concurrent/atomic/AtomicLong.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.