Class LongAdder
- java.lang.Object
-
- java.lang.Number
-
- java.util.concurrent.atomic.LongAdder
-
- All Implemented Interfaces:
- Serializable
public class LongAdder extends Number implements Serializable
One or more variables that together maintain an initially zerolong
sum. When updates (methodadd(long)
) are contended across threads, the set of variables may grow dynamically to reduce contention. Methodsum()
(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 aConcurrentHashMap<String,LongAdder> freqs
, initializing if not already present, you can usefreqs.computeIfAbsent(k -> new LongAdder()).increment();
This class extends
Number
, but does not define methods such asequals
,hashCode
andcompareTo
because instances are expected to be mutated, and so are not useful as collection keys.- Since:
- 1.8
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description LongAdder()
Creates a new adder with initial sum of zero.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description void
add(long x)
Adds the given value.void
decrement()
Equivalent toadd(-1)
.double
doubleValue()
Returns thesum()
as adouble
after a widening primitive conversion.float
floatValue()
Returns thesum()
as afloat
after a widening primitive conversion.void
increment()
Equivalent toadd(1)
.int
intValue()
Returns thesum()
as anint
after a narrowing primitive conversion.long
longValue()
Equivalent tosum()
.void
reset()
Resets variables maintaining the sum to zero.long
sum()
Returns the current sum.long
sumThenReset()
String
toString()
Returns the String representation of thesum()
.-
Methods inherited from class java.lang.Number
byteValue, shortValue
-
-
-
-
Method Detail
add
public void add(long x)
Adds the given value.- Parameters:
-
x
- the value to add
increment
public void increment()
Equivalent toadd(1)
.
decrement
public void decrement()
Equivalent toadd(-1)
.
sum
public long sum()
Returns the current sum. The returned value is NOT an atomic snapshot; invocation in the absence of concurrent updates returns an accurate result, but concurrent updates that occur while the sum is being calculated might not be incorporated.- Returns:
- the sum
reset
public void reset()
Resets variables maintaining the sum to zero. This method may be a useful alternative to creating a new adder, but is only effective if there are no concurrent updates. Because this method is intrinsically racy, it should only be used when it is known that no threads are concurrently updating.
sumThenReset
public long sumThenReset()
Equivalent in effect tosum()
followed byreset()
. 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
longValue
public long longValue()
Equivalent tosum()
.
intValue
public int intValue()
Returns thesum()
as anint
after a narrowing primitive conversion.
floatValue
public float floatValue()
Returns thesum()
as afloat
after a widening primitive conversion.- Specified by:
-
floatValue
in classNumber
- Returns:
-
the numeric value represented by this object after conversion to type
float
.
doubleValue
public double doubleValue()
Returns thesum()
as adouble
after a widening primitive conversion.- Specified by:
-
doubleValue
in classNumber
- Returns:
-
the numeric value represented by this object after conversion to type
double
.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.