Java.util Interface Spliterator in Java8
Last Updated :
30 May, 2018
Prerequisite : Iterators in java
Spliterators, like other Iterators, are for traversing the elements of a source. A source can be a
Collection, an
IO channel or a
generator function.
- It is included in JDK 8 for support of efficient parallel traversal(parallel programming) in addition to sequential traversal.
- However, you can use Spliterator even if you won’t be using parallel execution. One reason you might want to do so is because it combines the hasNext and next operations into one method.
For collections, Spliterator object can be created by calling spliterator() method present in Collection interface.
// Here "c" is any Collection object. splitr is of
// type Spliterator interface and refers to "c"
Spliterator splitr = c.spliterator();
Spliterator interface defines 8 methods:
- int characteristics() : Returns a set of characteristics of this Spliterator and its elements. The result is from ORDERED(0x00000010), DISTINCT(0x00000001), SORTED(0x00000004), SIZED(0x00000040), NONNULL(0x00000100), IMMUTABLE(0x00000400), CONCURRENT(0x00001000), SUBSIZED(0x00004000).
Syntax :
int characteristics()
Parameters :
NA
Returns :
Returns the characteristics of the invoking spliterator,
encoded into an integer.
- long estimateSize( ) : It returns an estimate the number of elements left to iterate or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
Syntax :
long estimateSize( )
Parameters :
NA
Returns :
Estimates the number of elements left to iterate and
returns the result. Returns Long.MAX_VALUE if the
count cannot be obtained for any reason.
- default long getExactSizeIfKnown( ) : Convenience method that returns estimateSize() if this Spliterator is SIZED, else -1.
Syntax :
default long getExactSizeIfKnown( )
Parameters :
NA
Returns :
If the invoking spliterator is SIZED, returns the number of
elements left to iterate. Returns –1 otherwise.
- default Comparator<? super T> getComparator( ) : If this Spliterator's source is SORTED by a Comparator, returns that Comparator. If the source is SORTED in natural order, returns null. Otherwise, if the source is not SORTED, throws IllegalStateException.
Syntax :
default Comparator<? super T> getComparator( )
Parameters :
NA
Returns :
Returns the comparator used by the invoking spliterator
or null if natural ordering is used.
Throws:
IllegalStateException - If the sequence is unordered,
IllegalStateException is thrown.
- default boolean hasCharacteristics(int val) : Returns true if this Spliterator's characteristics() contain all of the given characteristics.
Syntax :
default boolean hasCharacteristics(int val)
Parameters :
characteristics - the characteristics to check for
Returns :
Returns true if the invoking spliterator has the
characteristics passed in val. Returns false otherwise.
- boolean tryAdvance(Consumer<? super T> action) : If a remaining element exists, performs the given action on it, returning true; else returns false. If this Spliterator is ORDERED the action is performed on the next element in encounter order. Exceptions thrown by the action are relayed to the caller.
Syntax :
boolean tryAdvance(Consumer<? super T> action)
Parameters :
action - The action
Returns :
Returns true if there is a next element. Returns false if no
elements remain.
Throws :
NullPointerException - if the specified action is null
- default void forEachRemaining(Consumer<? super T>action) : 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. If this Spliterator is ORDERED, actions are performed in encounter order. Exceptions thrown by the action are relayed to the caller.
Syntax :
default void forEachRemaining(Consumer<? super T>action)
Parameters :
action - The action
Returns :
NA
Throws :
NullPointerException - if the specified action is null
- Spliterator<T> trySplit( ) : If possible, splits the invoking spliterator, returning a reference to a new spliterator for the partition. Otherwise, returns null. Thus, if successful, the original spliterator iterates over one portion of the sequence and the returned spliterator iterates over the other portion.
Syntax :
Spliterator<T> trySplit( )
Parameters :
NA
Returns :
a Spliterator covering some portion of the elements,
or null if this spliterator cannot be split
The below example demonstrate methods of Spliterator.
Java
// Java program to demonstrate
// methods of Spliterator
import java.util.ArrayList;
import java.util.Spliterator;
import java.util.stream.Stream;
public class SpliteratorDemo
{
public static void main(String[] args)
{
// Create an array list for doubles.
ArrayList<Integer> al = new ArrayList<>();
// Add values to the array list.
al.add(1);
al.add(2);
al.add(-3);
al.add(-4);
al.add(5);
// Obtain a Stream to the array list.
Stream<Integer> str = al.stream();
// getting Spliterator object on al
Spliterator<Integer> splitr1 = str.spliterator();
// estimateSize method
System.out.println("estimate size : " + splitr1.estimateSize());
// getExactSizeIfKnown method
System.out.println("exact size : " + splitr1.getExactSizeIfKnown());
// hasCharacteristics and characteristics method
System.out.println(splitr1.hasCharacteristics(splitr1.characteristics()));
System.out.println("Content of arraylist :");
// forEachRemaining method
splitr1.forEachRemaining((n) -> System.out.println(n));
// Obtaining another Stream to the array list.
Stream<Integer> str1 = al.stream();
splitr1 = str1.spliterator();
// trySplit() method
Spliterator<Integer> splitr2 = splitr1.trySplit();
// If splitr1 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("\nOutput from splitr1: ");
splitr1.forEachRemaining((n) -> System.out.println(n));
}
}
Output:
estimate size : 5
exact size : 5
true
Content of arraylist :
1
2
-3
-4
5
Output from splitr2:
1
2
Output from splitr1:
-3
-4
5
Java program for tryadvance method
Have a look at
tryAdvance() method.It performs an
action on the next element and then advances the iterator. It is shown here:
boolean tryAdvance(Consumer<? super T> action)
Here,
action specifies the action that is executed on the next element in the iteration and Consumer is a
functional interface that applies an action to an object. It is a generic functional interface declared in
java.util.function. It has only one abstract method,
accept( ), which is
shown here:
void accept(T objRef)
here T is type of object reference.
For implementing our
action, we must implement accept method.To implement accept method, here we use
lambda expression .This will be more clear from below example.
How to use Spliterator with Collections: Using Spliterator for basic iteration tasks is quite easy, simply call
tryAdvance( ) until it returns false.
Java
// Java program to demonstrate simple Spliterator
// using tryAdvance method
import java.util.ArrayList;
import java.util.Spliterator;
public class SpliteratorDemo
{
public static void main(String[] args)
{
// Create an array list for doubles.
ArrayList<Integer> al1 = new ArrayList<>();
// Add values to the array list.
al1.add(1);
al1.add(2);
al1.add(-3);
al1.add(-4);
al1.add(5);
// Use tryAdvance() to display(action) contents of arraylist.
System.out.print("Contents of arraylist:\n");
// getting Spliterator object on al1
Spliterator<Integer> splitr = al1.spliterator();
// Use tryAdvance() to display(action) contents of arraylist.
// Notice how lambda expression is used to implement accept method
// of Consumer interface
while(splitr.tryAdvance((n) -> System.out.println(n)));
// Use tryAdvance() for getting absolute values(action) of contents of arraylist.
// Create new list that contains absolute values.
ArrayList<Integer> al2 = new ArrayList<>();
splitr = al1.spliterator();
// Here our action is to get absolute values
// Notice how lambda expression is used to implement accept method
// of Consumer interface
while(splitr.tryAdvance((n) -> al2.add(Math.abs(n))));
System.out.print("Absolute values of contents of arraylist:\n");
// getting Spliterator object on al2
splitr = al2.spliterator();
while(splitr.tryAdvance((n) -> System.out.println(n)));
}
}
Output:
Contents of arraylist:
1
2
-3
-4
5
Absolute values of contents of arraylist:
1
2
3
4
5
Notice how tryAdvance( ) consolidates the purposes of hasNext( ) and next( ) provided by
Iterator into a single method in above example. This improves the efficiency of the iteration process.
In some cases, you might want to perform some action on each element collectively, rather than one at a time. To handle this type of situation, Spliterator provides the forEachRemaining( ) method, it is generally used in cases involving
streams. This method applies action to each unprocessed element and then returns.
Similar Reads
Java Tutorial Java is a high-level, object-oriented programming language used to build web apps, mobile applications, and enterprise software systems. Known for its Write Once, Run Anywhere capability, which means code written in Java can run on any device that supports the Java Virtual Machine (JVM).Syntax and s
10 min read
Basics
Introduction to JavaJava is a high-level, object-oriented programming language developed by Sun Microsystems in 1995. It is platform-independent, which means we can write code once and run it anywhere using the Java Virtual Machine (JVM). Java is mostly used for building desktop applications, web applications, Android
4 min read
Java Programming BasicsJava is one of the most popular and widely used programming language and platform. A platform is an environment that helps to develop and run programs written in any programming language. Java is fast, reliable and secure. From desktop to web applications, scientific supercomputers to gaming console
4 min read
Java MethodsJava Methods are blocks of code that perform a specific task. A method allows us to reuse code, improving both efficiency and organization. All methods in Java must belong to a class. Methods are similar to functions and expose the behavior of objects.Example: Java program to demonstrate how to crea
7 min read
Access Modifiers in JavaIn Java, access modifiers are essential tools that define how the members of a class, like variables, methods, and even the class itself, can be accessed from other parts of our program. They are an important part of building secure and modular code when designing large applications. In this article
6 min read
Arrays in JavaIn Java, an array is an important linear data structure that allows us to store multiple values of the same type. Arrays in Java are objects, like all other objects in Java, arrays implicitly inherit from the java.lang.Object class. This allows you to invoke methods defined in Object (such as toStri
9 min read
Java StringsIn Java, a String is the type of object that can store a sequence of characters enclosed by double quotes and every character is stored in 16 bits, i.e., using UTF 16-bit encoding. A string acts the same as an array of characters. Java provides a robust and flexible API for handling strings, allowin
8 min read
Regular Expressions in JavaIn Java, Regular Expressions or Regex (in short) in Java is an API for defining String patterns that can be used for searching, manipulating, and editing a string in Java. Email validation and passwords are a few areas of strings where Regex is widely used to define the constraints. Regular Expressi
7 min read
OOPs & Interfaces
Classes and Objects in JavaIn Java, classes and objects are basic concepts of Object Oriented Programming (OOPs) that are used to represent real-world concepts and entities. A class is a template to create objects having similar properties and behavior, or in other words, we can say that a class is a blueprint for objects.An
10 min read
Java ConstructorsIn Java, constructors play an important role in object creation. A constructor is a special block of code that is called when an object is created. Its main job is to initialize the object, to set up its internal state, or to assign default values to its attributes. This process happens automaticall
10 min read
Java OOP(Object Oriented Programming) ConceptsBefore Object-Oriented Programming (OOPs), most programs used a procedural approach, where the focus was on writing step-by-step functions. This made it harder to manage and reuse code in large applications.To overcome these limitations, Object-Oriented Programming was introduced. Java is built arou
10 min read
Java PackagesPackages in Java are a mechanism that encapsulates a group of classes, sub-packages and interfaces. Packages are used for: Prevent naming conflicts by allowing classes with the same name to exist in different packages, like college.staff.cse.Employee and college.staff.ee.Employee.They make it easier
8 min read
Java InterfaceAn Interface in Java programming language is defined as an abstract type used to specify the behaviour of a class. An interface in Java is a blueprint of a behaviour. A Java interface contains static constants and abstract methods. Key Properties of Interface:The interface in Java is a mechanism to
11 min read
Collections
Exception Handling
Java Exception HandlingException handling in Java is an effective mechanism for managing runtime errors to ensure the application's regular flow is maintained. Some Common examples of exceptions include ClassNotFoundException, IOException, SQLException, RemoteException, etc. By handling these exceptions, Java enables deve
8 min read
Java Try Catch BlockA try-catch block in Java is a mechanism to handle exceptions. This make sure that the application continues to run even if an error occurs. The code inside the try block is executed, and if any exception occurs, it is then caught by the catch block.Example: Here, we are going to handle the Arithmet
4 min read
Java final, finally and finalizeIn Java, the keywords "final", "finally" and "finalize" have distinct roles. final enforces immutability and prevents changes to variables, methods, or classes. finally ensures a block of code runs after a try-catch, regardless of exceptions. finalize is a method used for cleanup before an object is
4 min read
Chained Exceptions in JavaChained Exceptions in Java allow associating one exception with another, i.e. one exception describes the cause of another exception. For example, consider a situation in which a method throws an ArithmeticException because of an attempt to divide by zero.But the root cause of the error was an I/O f
3 min read
Null Pointer Exception in JavaA NullPointerException in Java is a RuntimeException. It occurs when a program attempts to use an object reference that has the null value. In Java, "null" is a special value that can be assigned to object references to indicate the absence of a value.Reasons for Null Pointer ExceptionA NullPointerE
5 min read
Exception Handling with Method Overriding in JavaException handling with method overriding in Java refers to the rules and behavior that apply when a subclass overrides a method from its superclass and both methods involve exceptions. It ensures that the overridden method in the subclass does not declare broader or new checked exceptions than thos
4 min read
Java Advanced
Java Multithreading TutorialThreads are the backbone of multithreading. We are living in the real world which in itself is caught on the web surrounded by lots of applications. With the advancement in technologies, we cannot achieve the speed required to run them simultaneously unless we introduce the concept of multi-tasking
15+ min read
Synchronization in JavaIn multithreading, synchronization is important to make sure multiple threads safely work on shared resources. Without synchronization, data can become inconsistent or corrupted if multiple threads access and modify shared variables at the same time. In Java, it is a mechanism that ensures that only
10 min read
File Handling in JavaIn Java, with the help of File Class, we can work with files. This File Class is inside the java.io package. The File class can be used to create an object of the class and then specifying the name of the file.Why File Handling is Required?File Handling is an integral part of any programming languag
6 min read
Java Method ReferencesIn Java, a method is a collection of statements that perform some specific task and return the result to the caller. A method reference is the shorthand syntax for a lambda expression that contains just one method call. In general, one does not have to pass arguments to method references.Why Use Met
9 min read
Java 8 Stream TutorialJava 8 introduces Stream, which is a new abstract layer, and some new additional packages in Java 8 called java.util.stream. A Stream is a sequence of components that can be processed sequentially. These packages include classes, interfaces, and enum to allow functional-style operations on the eleme
15+ min read
Java NetworkingWhen computing devices such as laptops, desktops, servers, smartphones, and tablets and an eternally-expanding arrangement of IoT gadgets such as cameras, door locks, doorbells, refrigerators, audio/visual systems, thermostats, and various sensors are sharing information and data with each other is
15+ min read
JDBC TutorialJDBC stands for Java Database Connectivity. JDBC is a Java API or tool used in Java applications to interact with the database. It is a specification from Sun Microsystems that provides APIs for Java applications to communicate with different databases. Interfaces and Classes for JDBC API comes unde
12 min read
Java Memory ManagementJava memory management is the process by which the Java Virtual Machine (JVM) automatically handles the allocation and deallocation of memory. It uses a garbage collector to reclaim memory by removing unused objects, eliminating the need for manual memory managementJVM Memory StructureJVM defines va
4 min read
Garbage Collection in JavaGarbage collection in Java is an automatic memory management process that helps Java programs run efficiently. Java programs compile to bytecode that can be run on a Java Virtual Machine (JVM). When Java programs run on the JVM, objects in the heap are created, which is a portion of memory dedicated
7 min read
Memory Leaks in JavaIn programming, a memory leak happens when a program keeps using memory but does not give it back when it's done. It simply means the program slowly uses more and more memory, which can make things slow and even stop working. Working of Memory Management in JavaJava has automatic garbage collection,
3 min read
Practice Java
Java Interview Questions and AnswersJava is one of the most popular programming languages in the world, known for its versatility, portability, and wide range of applications. Java is the most used language in top companies such as Uber, Airbnb, Google, Netflix, Instagram, Spotify, Amazon, and many more because of its features and per
15+ min read
Java Programs - Java Programming ExamplesIn this article, we will learn and prepare for Interviews using Java Programming Examples. From basic Java programs like the Fibonacci series, Prime numbers, Factorial numbers, and Palindrome numbers to advanced Java programs.Java is one of the most popular programming languages today because of its
8 min read
Java Exercises - Basic to Advanced Java Practice Programs with SolutionsLooking for Java exercises to test your Java skills, then explore our topic-wise Java practice exercises? Here you will get 25 plus practice problems that help to upscale your Java skills. As we know Java is one of the most popular languages because of its robust and secure nature. But, programmers
7 min read
Java Quiz | Level Up Your Java SkillsThe best way to scale up your coding skills is by practicing the exercise. And if you are a Java programmer looking to test your Java skills and knowledge? Then, this Java quiz is designed to challenge your understanding of Java programming concepts and assess your excellence in the language. In thi
1 min read
Top 50 Java Project Ideas For Beginners and Advanced [Update 2025]Java is one of the most popular and versatile programming languages, known for its reliability, security, and platform independence. Developed by James Gosling in 1982, Java is widely used across industries like big data, mobile development, finance, and e-commerce.Building Java projects is an excel
15+ min read