Java Interface Spliterator

Spliterators can be used for traversing the elements of a source one by one. These sources could be an array, a Collection, an IO Channel or a generator function.

The main functionalities of Spliterator are-

Splitting the source data
Processing the source data

The Interface Spliterator is included in JDK 8 for taking the advantages of parallelism in addition to sequential traversal. It is designed as a parallel analogue of an iterator.

Java Interface Spliterator Declaration

Java Interface Spliterator Methods

The list of all Java Spliterator methods with some useful description are given below-

SN	Modifier & Type	Method	Description
1)	int	characteristics()	It is used to get a set of characteristics of this Spliterator and its elements.
2)	long	estimateSize()	It is used to get an estimate of the number of elements remaining to iterate or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
3)	default void	ForEachRemaining(Consumer action>)	It is used to performs the given action for each remaining element sequentially in the current thread until all elements have been processed or the action throws an exception.
4)	default comparator	getComaparator()	It is used to get a Comparator if the given Spliterator?s source is SORTED by a Comparator.
5)	default long	getExactSizeIfKnown()	It is used to get an estimateSize() of the SIZED spliterator, otherwise returns -1.
6)	default boolean	hasCharacteristics(int characteristics)	It returns true if this Spliterator's characteristics() contain all of the given characteristics.
7)	boolean	TryAdvance(Consumer action>)	It is used to get the existing elements upon performing the specified action on it.
8)	splierator	trySplit()	It is used to splits the invoking spliterator if this spliterator can be partitioned, returns a reference to a new spliterator for the partition. Otherwise, it returns null.

Example 1

import java.util.*;
import java.util.stream.Stream;
public class InterfaceSpliteratorExample1 {  
     public static void main(String args[]){
    	   //Create an object of array list
         ArrayList<Integer> list = new ArrayList<>();             
         //Add values to the array list.
         list.add(101);
         list.add(201);
         list.add(301);
         list.add(401);
         list.add(501);                      
         Stream<Integer> str = list.stream();             
         //Get Spliterator object on list
         Spliterator<Integer> splitr = str.spliterator();                                            
         //Get estimateSize method
         System.out.println("Estimate size: " + splitr.estimateSize());                 
         //Print getExactSizeIfKnown method
         System.out.println("Exact size: " + splitr.getExactSizeIfKnown());          
         //Check for hasCharacteristics and characteristics method
         System.out.println("Boolean Result: "+splitr.hasCharacteristics(splitr.characteristics()));          
         System.out.println("Elements of ArrayList :");
         //Obtain result forEachRemaining method    
         splitr.forEachRemaining((n) -> System.out.println(n));        
         //Obtaining another Stream to the array list.
         Stream<Integer> str1 = list.stream();
         splitr = str1.spliterator();         
         //Obtain result from trySplit() method
         Spliterator<Integer> splitr2 = splitr.trySplit();         
         //If splitr could be split, use splitr2 first.
         if(splitr2 != null) {
         System.out.println("Output from splitr2: ");
         splitr2.forEachRemaining((n) -> System.out.println(n));
         }  
         //Now, use the splitr
         System.out.println("Output from splitr1: ");
         splitr.forEachRemaining((n) -> System.out.println(n));
         }
}

Test it Now

Output:

Estimate size: 5
Exact size: 5
Boolean Result: true
Elements of ArrayList :
101
201
301
401
501
Output from splitr2: 
101
201
Output from splitr1: 
301
401
501

Example 2

import java.util.*;
public class InterfaceSpliteratorExample2 {  
     public static void main(String args[]){
    	 List<String> fruitList = Arrays.asList("Mango", "Banana", "Apple");
    	 Spliterator<String> splitr = fruitList.spliterator();
    	 System.out.println("List of Fruit name-");
    	 while(splitr.tryAdvance((num) -> System.out.println("" +num)));
       }
}

Test it Now

Output:

List of Fruit name-
Mango
Banana
Apple

Example 3

import java.util.*;
public class InterfaceSpliteratorExample3 {  
	public static void main (String[] args) {
	    List<String> progList = Arrays.asList("Java","Android","Python","C++");
	    Spliterator<String> splitr = progList.spliterator();
	    Spliterator<String> st = splitr.trySplit();
	    splitr.forEachRemaining(System.out::println);
	    System.out.println("Traversing the next half of the spliterator-");
	    st.forEachRemaining(System.out::println);
          }
}

Test it Now

Output:

Python
C++
Traversing the next half of the spliterator-
Java
Android

Next TopicJava Spliterator class

← prev next →

Help Others, Please Share

Javatpoint Services

JavaTpoint offers too many high quality services. Mail us on [email protected], to get more information about given services.

Website Designing
Website Development
Java Development
PHP Development
WordPress
Graphic Designing
Logo
Digital Marketing
On Page and Off Page SEO
PPC
Content Development
Corporate Training
Classroom and Online Training
Data Entry

Training For College Campus

JavaTpoint offers college campus training on Core Java, Advance Java, .Net, Android, Hadoop, PHP, Web Technology and Python. Please mail your requirement at [email protected].
Duration: 1 week to 2 week

^{Like/Subscribe us for latest updates or newsletter}

Java Spliterator Class

Java Interface Spliterator

Java Interface Spliterator Declaration

Java Interface Spliterator Methods

Example 1

Example 2

Example 3

Help Others, Please Share

Javatpoint Services

Training For College Campus