Class LongAdder
- All Implemented Interfaces:
Serializable
public class LongAdder extends Number implements Serializable
long sum. When updates (method add(long)) are contended across threads, the set of variables may grow dynamically to reduce contention. Method sum() (or, equivalently, longValue()) returns the current total combined across the variables maintaining the sum. This class is usually preferable to AtomicLong when multiple threads update a common sum that is used for purposes such as collecting statistics, not for fine-grained synchronization control. Under low update contention, the two classes have similar characteristics. But under high contention, expected throughput of this class is significantly higher, at the expense of higher space consumption.
LongAdders can be used with a ConcurrentHashMap to maintain a scalable frequency map (a form of histogram or multiset). For example, to add a count to a ConcurrentHashMap<String,LongAdder> freqs, initializing if not already present, you can use
freqs.computeIfAbsent(key, k -> new LongAdder()).increment();
This class extends Number, but does not define methods such as equals, hashCode and
compareTo because instances are expected to be mutated, and so are not useful as collection keys.
- Since:
- 1.8
- See Also:
Constructor Summary
| Constructor | Description |
|---|---|
LongAdder() |
Creates a new adder with initial sum of zero. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
void |
add |
Adds the given value. |
void |
decrement() |
Equivalent to add(-1). |
double |
doubleValue() |
Returns the sum() as a double after a widening primitive conversion. |
float |
floatValue() |
Returns the sum() as a float after a widening primitive conversion. |
void |
increment() |
Equivalent to add(1). |
int |
intValue() |
Returns the sum() as an int after a narrowing primitive conversion. |
long |
longValue() |
Equivalent to sum(). |
void |
reset() |
Resets variables maintaining the sum to zero. |
long |
sum() |
Returns the current sum. |
long |
sumThenReset() |
|
String |
toString() |
Returns the String representation of the sum(). |
Methods declared in class Number
byteValue, shortValue | Modifier and Type | Method | Description |
|---|---|---|
byte |
byteValue() |
Returns the value of the specified number as a byte. |
short |
shortValue() |
Returns the value of the specified number as a short. |
Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | Modifier and Type | Method | Description |
|---|---|---|
protected Object |
clone() |
Creates and returns a copy of this object. |
boolean |
equals |
Indicates whether some other object is "equal to" this one. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release. |
final Class |
getClass() |
Returns the runtime class of this Object. |
int |
hashCode() |
Returns a hash code value for this object. |
final void |
notify() |
Wakes up a single thread that is waiting on this object's monitor. |
final void |
notifyAll() |
Wakes up all threads that are waiting on this object's monitor. |
final void |
wait() |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
final void |
wait |
Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. |
Constructor Details
LongAdder
public LongAdder()
Method Details
add
public void add(long x)
- Parameters:
-
x- the value to add
increment
public void increment()
add(1).decrement
public void decrement()
add(-1).sum
public long sum()
- Returns:
- the sum
reset
public void reset()
sumThenReset
public long sumThenReset()
sum() followed by reset(). This method may apply for example during quiescent points between multithreaded computations. If there are updates concurrent with this method, the returned value is not guaranteed to be the final value occurring before the reset.- Returns:
- the sum
toString
longValue
intValue
floatValue
public float floatValue()
sum() as a float after a widening primitive conversion.- Specified by:
-
floatValuein classNumber - Returns:
- the numeric value represented by this object after conversion to type
float.
doubleValue
public double doubleValue()
sum() as a double after a widening primitive conversion.- Specified by:
-
doubleValuein classNumber - Returns:
- the numeric value represented by this object after conversion to type
double.
© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.