Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/java/util/LongSummaryStatistics#pubctors) \| [Methods](https://developer.android.com/reference/java/util/LongSummaryStatistics#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/java/util/LongSummaryStatistics#inhmethods)

# LongSummaryStatistics

` public class LongSummaryStatistics `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/util/function/IntConsumer, https://developer.android.com/reference/java/util/function/LongConsumer `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | java.util.LongSummaryStatistics |

<br />

*** ** * ** ***

A state object for collecting statistics such as count, min, max, sum, and average.

This class is designed to work with (though does not require) [streams](https://developer.android.com/reference/java/util/stream/package-summary). For example, you can compute summary statistics on a stream of longs with:

    LongSummaryStatistics stats = longStream.collect(LongSummaryStatistics::new,
                                                      LongSummaryStatistics::accept,
                                                      LongSummaryStatistics::combine);
     
`LongSummaryStatistics` can be used as a [reduction](https://developer.android.com/reference/java/util/stream/Stream#collect(java.util.stream.Collector<?%20super%20T,A,R>)) target for a [stream](https://developer.android.com/reference/java/util/stream/Stream). For example:

    LongSummaryStatistics stats = people.stream()
                                         .collect(Collectors.summarizingLong(Person::getAge));

This computes, in a single pass, the count of people, as well as the minimum, maximum, sum, and average of their ages.

<br />

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/java/util/LongSummaryStatistics#LongSummaryStatistics()() ` Constructs an empty instance with zero count, zero sum, `Long.MAX_VALUE` min, `Long.MIN_VALUE` max and zero average. |
| ` https://developer.android.com/reference/java/util/LongSummaryStatistics#LongSummaryStatistics(long,%20long,%20long,%20long)(long count, long min, long max, long sum) ` Constructs a non-empty instance with the specified `count`, `min`, `max`, and `sum`. |

| ### Public methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#accept(int)(int value) ` Records a new `int` value into the summary information. |
| ` void` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#accept(long)(long value) ` Records a new `long` value into the summary information. |
| ` void` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#combine(java.util.LongSummaryStatistics)(https://developer.android.com/reference/java/util/LongSummaryStatistics other) ` Combines the state of another `LongSummaryStatistics` into this one. |
| ` final double` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#getAverage()() ` Returns the arithmetic mean of values recorded, or zero if no values have been recorded. |
| ` final long` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#getCount()() ` Returns the count of values recorded. |
| ` final long` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#getMax()() ` Returns the maximum value recorded, or `Long.MIN_VALUE` if no values have been recorded |
| ` final long` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#getMin()() ` Returns the minimum value recorded, or `Long.MAX_VALUE` if no values have been recorded. |
| ` final long` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#getSum()() ` Returns the sum of values recorded, or zero if no values have been recorded. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/util/LongSummaryStatistics#toString()() ` Returns a non-empty string representation of this object suitable for debugging. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/java/util/function/IntConsumer ` ` abstract void` ` https://developer.android.com/reference/java/util/function/IntConsumer#accept(int)(int value) `

Performs this operation on the given argument.
` default https://developer.android.com/reference/java/util/function/IntConsumer` ` https://developer.android.com/reference/java/util/function/IntConsumer#andThen(java.util.function.IntConsumer)(https://developer.android.com/reference/java/util/function/IntConsumer after) `

Returns a composed `IntConsumer` that performs, in sequence, this operation followed by the `after` operation.
From interface ` https://developer.android.com/reference/java/util/function/LongConsumer ` ` abstract void` ` https://developer.android.com/reference/java/util/function/LongConsumer#accept(long)(long value) `

Performs this operation on the given argument.
` default https://developer.android.com/reference/java/util/function/LongConsumer` ` https://developer.android.com/reference/java/util/function/LongConsumer#andThen(java.util.function.LongConsumer)(https://developer.android.com/reference/java/util/function/LongConsumer after) `

Returns a composed `LongConsumer` that performs, in sequence, this operation followed by the `after` operation.

## Public constructors

### LongSummaryStatistics

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public LongSummaryStatistics ()
```

Constructs an empty instance with zero count, zero sum, `Long.MAX_VALUE` min, `Long.MIN_VALUE` max and zero average.

<br />

### LongSummaryStatistics

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public LongSummaryStatistics (long count, 
                long min, 
                long max, 
                long sum)
```

Constructs a non-empty instance with the specified `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`

<br />

<br />

##### API Note:

- The enforcement of argument correctness means that the retrieved set of recorded values obtained from a `LongSummaryStatistics` 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.

| Parameters ||
|---|---|
| `count` | `long`: the count of values <br /> |
| `min` | `long`: the minimum value <br /> |
| `max` | `long`: the maximum value <br /> |
| `sum` | `long`: the sum of all values <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the arguments are inconsistent |

## Public methods

### accept

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void accept (int value)
```

Records a new `int` value into the summary information.

<br />

| Parameters ||
|---|---|
| `value` | `int`: the input value <br /> |

### accept

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void accept (long value)
```

Records a new `long` value into the summary information.

<br />

| Parameters ||
|---|---|
| `value` | `long`: the input value <br /> |

### combine

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void combine (LongSummaryStatistics other)
```

Combines the state of another `LongSummaryStatistics` into this one.

<br />

| Parameters ||
|---|---|
| `other` | `LongSummaryStatistics`: another `LongSummaryStatistics` <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if `other` is null |

### getAverage

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final double getAverage ()
```

Returns the arithmetic mean of values recorded, or zero if no values have been recorded.

<br />

| Returns ||
|---|---|
| `double` | The arithmetic mean of values, or zero if none <br /> |

### getCount

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final long getCount ()
```

Returns the count of values recorded.

<br />

| Returns ||
|---|---|
| `long` | the count of values <br /> |

### getMax

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final long getMax ()
```

Returns the maximum value recorded, or `Long.MIN_VALUE` if no values have been recorded

<br />

| Returns ||
|---|---|
| `long` | the maximum value, or `Long.MIN_VALUE` if none <br /> |

### getMin

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final long getMin ()
```

Returns the minimum value recorded, or `Long.MAX_VALUE` if no values have been recorded.

<br />

| Returns ||
|---|---|
| `long` | the minimum value, or `Long.MAX_VALUE` if none <br /> |

### getSum

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public final long getSum ()
```

Returns the sum of values recorded, or zero if no values have been recorded.

<br />

| Returns ||
|---|---|
| `long` | the sum of values, or zero if none <br /> |

### toString

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a non-empty string representation of this object suitable for debugging. The exact presentation format is unspecified and may vary between implementations and versions.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |