IntSummaryStatistics Class in Java

The IntSummaryStatistics class is one of the most important classes present in the java.util.package. It provides a set of integer objects which are used at the time of dealing with a stream of integers. It keeps the count of the number of integers processed, their sum and various other statistics. We can also use these classes with Streams. The class is mainly used in the manipulation of statistical data.

java.lang.Object → java.util.IntSummaryStatistics

Constructors

The IntSummaryStatistics class has following two constructors:

1. IntSummaryStatistics()

It is a default constructor that will initialize the sum and count to zero and set min to Integer.MIN_VALUE and max to Integer.MAX_VALUE.

Syntax

2. IntSummaryStatistics(count, min, max, sum)

It is a parameterized constructor that will initialize the sum, count, min and max with the given parameters.

Syntax

public IntSummaryStatistics(long count, int min, int max, long sum) throws IllegalArgumentException

IntSummaryStatistics Class Methods

The IntSummaryStatistics class has more than one method for performing the manipulation of statistical data. Let's understand each one of them one by one with an example.

accept(int value) Method

The accept() method is an important method provided by the IntSummaryStatistics class that is used for accepting the given value into this summary information.

Syntax

Parameter

It accepts an integer value as a parameter that is to be recorded into this IntSummaryStatistics.

Return value

NA.

Let's take an example to understand the use of the accept() method.

IntSummaryStatisticsExample1.java

// import required classes and package if any
import java.util.*;

// create IntSummaryStatisticsExample1 class to understand the use of accept() method
public class IntSummaryStatisticsExample1 {
	
	// main() method start
	public static void main(String[] args){
		
		int n;
		
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();

		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}

		// close Scanner class object
		sc.close();
		
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		
		// repeat iterator elements
		while (iterator.hasNext()) {
			
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}

		System.out.println(obj.toString());
	}
}

Output:

combine(IntSummaryStatistics other) Method

The combine() method is another important method provided by the IntSummaryStatistics class that is used for combining two IntSummaryStatistics objects.

Syntax

Parameter

It accepts an object of IntSummaryStatistics, which is going to combine with the current statistical data.

Return value

NA.

Let's take an example to understand the use of the combine() method.

IntSummaryStatisticsExample2.java

// import required classes and package if any
package JavaTpoint.Examples;
import java.util.*;
// create IntSummaryStatisticsExample2 class to understand the use of accept() method
public class IntSummaryStatisticsExample2 {
	// main() method start
	public static void main(String[] args){
		int n;
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj1 = new IntSummaryStatistics();
		IntSummaryStatistics obj2 = new IntSummaryStatistics();
		// create an empty list of Integer
		List<Integer> list1 = new ArrayList<Integer>();
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list1.add(sc.nextInt());
		}
		// close Scanner class object
		sc.close();
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator1 = list1.listIterator();
		// repeat iterator elements
		while (iterator1.hasNext()) {
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj1.accept(iterator1.next());
		}
		System.out.println("1st IntSummaryStatistics ==>"+obj1.toString());
		List<Integer> list2 = Arrays.asList(10, 20, 30, 40, 50);
		Iterator<Integer> iterator2 = list2.listIterator();
		while (iterator2.hasNext()) {
			obj2.accept(iterator2.next());
		}
		System.out.println("2nd IntSummaryStatistics ==>"+obj2.toString());
		obj1.combine(obj2);
		System.out.println("After combining 1st and 2nd IntSummaryStatistics object ==>"+obj1);
	}
}

Output:

getCount() Method

The getCount() method is another important method provided by the IntSummaryStatistics class that is used to get the count of the number of integers processed.

Syntax

Parameter

NA.

Return value

It returns the count of the numbers of integers processed.

Let's take an example to understand the use of the getCount() method.

IntSummaryStatisticsExample3.java

// import required classes and package if any
import java.util.*;
// create IntSummaryStatisticsExample3 class to understand the use of getCount() method
public class IntSummaryStatisticsExample3 {
	// main() method start
	public static void main(String[] args){
		int n;
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();
		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}
		// close Scanner class object
		sc.close();
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		// repeat iterator elements
		while (iterator.hasNext()) {
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}
		// use the getCount() method to get the count of the number of integers processed
		System.out.println("Count ==> "+obj.getCount());
	}
}

Output:

getSum() Method

The getSum() method is another important method provided by the IntSummaryStatistics class that is used to get the sum of all integers processed.

Syntax

Parameter

NA.

Return value

It returns the sum of all integers processed.

Let's take an example to understand the use of the getSum() method.

IntSummaryStatisticsExample4.java

//import required classes and package if any
import java.util.*;
//create IntSummaryStatisticsExample4 class to understand the use of getSum() method
public class IntSummaryStatisticsExample4 {
	// main() method start
	public static void main(String[] args){
		int n;
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();
		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}
		// close Scanner class object
		sc.close();
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		// repeat iterator elements
		while (iterator.hasNext()) {
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}
		// use getCount() method to get the sum of all integers processed
		System.out.println("Sum ==> "+obj.getSum());
	}
}

Output:

getAverage() Method

The getSum() method is another important method provided by the IntSummaryStatistics class that is used to get the average of all integers processed.

Syntax

Parameter

NA.

Return value

It returns the average of all integers processed.

Let's take an example to understand the use of the getAverage() method.

IntSummaryStatisticsExample5.java

//import required classes and package if any
import java.util.*;
//create IntSummaryStatisticsExample5 class to understand the use of getAverage() method
public class IntSummaryStatisticsExample5 {
	// main() method start
	public static void main(String[] args){
		int n;
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();
		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}
		// close Scanner class object
		sc.close();
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		// repeat iterator elements
		while (iterator.hasNext()) {
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}
		// use getCount() method to get the average of all integers processed
		System.out.println("Average ==> "+obj.getSum());
	}
}

Output:

getMin() Method

The getMin() method is another important method provided by the IntSummaryStatistics class that is used to get the minimum Integer of all integers processed.

Syntax

Parameter

NA.

Return value

It returns the minimum Integer of all integers processed.

Let's take an example to understand the use of the getMin() method.

IntSummaryStatisticsExample6.java

//import required classes and package if any
import java.util.*;

//create IntSummaryStatisticsExample6 class to understand the use of getMin() method
public class IntSummaryStatisticsExample6 {
	
	// main() method start
	public static void main(String[] args){
		
		int n;
		
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();

		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}

		// close Scanner class object
		sc.close();
		
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		
		// repeat iterator elements
		while (iterator.hasNext()) {
			
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}
		
		// use getCount() method to get minimum integer of all integers processed
		System.out.println("Min ==> "+obj.getMin());
	}
}

Output:

getMax() Method

The getMax() method is another important method provided by the IntSummaryStatistics class that is used to get the maximum Integer of all integers processed.

Syntax

public final int getMax()

Parameter

NA.

Return value

It returns the maximum Integer of all integers processed.

Let's take an example to understand the use of the getMax() method.

IntSummaryStatisticsExample7.java

//import required classes and package if any
import java.util.*;

//create IntSummaryStatisticsExample7 class to understand the use of getMax() method
public class IntSummaryStatisticsExample7 {
	
	// main() method start
	public static void main(String[] args){
		
		int n;
		
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();

		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}

		// close Scanner class object
		sc.close();
		
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		
		// repeat iterator elements
		while (iterator.hasNext()) {
			
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}
		
		// use getMax() method to get maximum integer of all integers processed
		System.out.println("Max ==> "+obj.getMax());
	}
}

Output:

toString() Method

The toString() method is used to get the string representation of all statistical data contained in the project.

Syntax

Parameter

NA.

Return value

It returns the string representation of the IntSummaryStatistics object.

Let's take an example to understand the use of the toString() method.

IntSummaryStatisticsExample8.java

//import required classes and package if any
import java.util.*;

//create IntSummaryStatisticsExample8 class to understand the use of toString() method
public class IntSummaryStatisticsExample8 {
	
	// main() method start
	public static void main(String[] args){
		
		int n;
		
		// create an instance of IntSummaryStatistics class
		IntSummaryStatistics obj = new IntSummaryStatistics();

		// create an empty list of Integer
		List<Integer> list = new ArrayList<Integer>();
		
		// create and instance of Scanner class
		Scanner sc = new Scanner(System.in);
		
		System.out.println("How many integers you want to add to the IntSummaryStatistics object");
		n = sc.nextInt();
		
		for(int i = 0; i < n;  i++) {
			System.out.println("Enter "+(i+1)+" element.");
			list.add(sc.nextInt());
		}

		// close Scanner class object
		sc.close();
		
		// create an Iterator of integer with list elements
		Iterator<Integer> iterator = list.listIterator();
		
		// repeat iterator elements
		while (iterator.hasNext()) {
			
			// use accept() method for adding the integers to the IntSummaryStatistics object
			obj.accept(iterator.next());
		}
		
		// string representation
		System.out.println("String Representation ==> "+obj.toString());
	}
}

Output: