IntConsumer
public class IntSummaryStatistics extends Object implements IntConsumer
This class is designed to work with (though does not require) streams. For example, you can compute summary statistics on a stream of ints with:
IntSummaryStatistics stats = intStream.collect(IntSummaryStatistics::new,
IntSummaryStatistics::accept,
IntSummaryStatistics::combine);
IntSummaryStatistics
can be used as a reduction target for a stream. For example:
IntSummaryStatistics stats = people.stream()
.collect(Collectors.summarizingInt(Person::getDependents));
This computes, in a single pass, the count of people, as well as the minimum, maximum, sum, and average of their number of dependents.Collectors.summarizingInt()
on a parallel stream, because the parallel implementation of Stream.collect()
provides the necessary partitioning, isolation, and merging of results for safe and efficient parallel execution. This implementation does not check for overflow of the count or the sum.
Constructor | Description |
---|---|
IntSummaryStatistics() |
Constructs an empty instance with zero count, zero sum, Integer.MAX_VALUE min, Integer.MIN_VALUE max and zero average. |
IntSummaryStatistics |
Constructs a non-empty instance with the specified count , min , max , and sum . |
Modifier and Type | Method | Description |
---|---|---|
void |
accept |
Records a new value into the summary information |
void |
combine |
Combines the state of another IntSummaryStatistics into this one. |
final double |
getAverage() |
Returns the arithmetic mean of values recorded, or zero if no values have been recorded. |
final long |
getCount() |
Returns the count of values recorded. |
final int |
getMax() |
Returns the maximum value recorded, or Integer.MIN_VALUE if no values have been recorded. |
final int |
getMin() |
Returns the minimum value recorded, or Integer.MAX_VALUE if no values have been recorded. |
final long |
getSum() |
Returns the sum of values recorded, or zero if no values have been recorded. |
String |
toString() |
Returns a non-empty string representation of this object suitable for debugging. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
andThen
public IntSummaryStatistics()
Integer.MAX_VALUE
min, Integer.MIN_VALUE
max and zero average.public IntSummaryStatistics(long count, int min, int max, long sum) throws IllegalArgumentException
count
, min
, max
, and sum
. If count
is zero then the remaining arguments are ignored and an empty instance is constructed.
If the arguments are inconsistent then an IllegalArgumentException
is thrown. The necessary consistent argument conditions are:
count >= 0
min <= max
IntSummaryStatistics
source instance may not be a legal set of arguments for this constructor due to arithmetic overflow of the source's recorded count of values. The consistent argument conditions are not sufficient to prevent the creation of an internally inconsistent instance. An example of such a state would be an instance with: count
= 2, min
= 1, max
= 2, and sum
= 0.count
- the count of valuesmin
- the minimum valuemax
- the maximum valuesum
- the sum of all valuesIllegalArgumentException
- if the arguments are inconsistentpublic void accept(int value)
accept
in interface IntConsumer
value
- the input valuepublic void combine(IntSummaryStatistics other)
IntSummaryStatistics
into this one.other
- another IntSummaryStatistics
NullPointerException
- if other
is nullpublic final long getCount()
public final long getSum()
public final int getMin()
Integer.MAX_VALUE
if no values have been recorded.Integer.MAX_VALUE
if nonepublic final int getMax()
Integer.MIN_VALUE
if no values have been recorded.Integer.MIN_VALUE
if nonepublic final double getAverage()
public String toString()
© 1993, 2023, 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.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/IntSummaryStatistics.html