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));
}
}
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
Serializable Interface in Java
The Serializable interface is present in java.io package. It is a marker interface. A Marker Interface does not have any methods and fields. Thus classes implementing it do not have to implement any methods. Classes implement it if they want their instances to be Serialized or Deserialized. Serializ
2 min read
Iterator Interface In Java
Java Iterator Interface of java collections allows us to access elements of the collection and is used to iterate over the elements in the collection(Map, List or Set). It helps to easily retrieve the elements of a collection and perform operations on each element. Iterator is a universal iterator a
6 min read
Match Lambdas to Interfaces in Java
One of the most popular and important topics is lambda expression in java but before going straight into our discussion, let us have insight into some important things. Starting off with the interfaces in java as interfaces are the reference types that are similar to classes but containing only abst
5 min read
MatchResult Interface in Java
Interface in java is used to achieve abstraction. It is also considered as the blueprint for the class. An interface can contain abstract methods only but it might or might not contain variables. In other words, an interface can contain abstract methods and variables only. Java supports multiple inh
7 min read
Nested Interface in Java
We can declare interfaces as members of a class or another interface. Such an interface is called a member interface or nested interface. Interfaces declared outside any class can have only public and default (package-private) access specifiers. In Java, nested interfaces (interfaces declared inside
5 min read
TransferQueue Interface in Java
The TransferQueue interface is a member of the Java Collections Framework. It was introduced in JDK 1.7, it belongs to java.util.concurrent package. The TransferQueue is a BlockingQueue in which a sending thread(producer) may wait for the receiving thread(consumers) to receive elements. TransferQueu
8 min read
Java Program to Convert Iterator to Spliterator
Given an Iterator, the task is to convert it into Spliterators in Java. Examples: Input: Iterator = {1, 2, 3, 4, 5} Output: {1, 2, 3, 4, 5} Input: Iterator = {'G', 'e', 'e', 'k', 's'} Output: {'G', 'e', 'e', 'k', 's'} Approach: Get the Iterator. Convert the iterator to Spliterator using Spliterators
1 min read
Queue Interface In Java
The Queue Interface is a part of java.util package and extends the Collection interface. It stores and processes the data in order means elements are inserted at the end and removed from the front. Key Features:Most implementations, like PriorityQueue, do not allow null elements.Implementation Class
11 min read
Java Collection spliterator() with Examples
The spliterator() in Java Collection creates a spliterator over the elements in the collection. In simple words, it's an iterator that allows you to traverse the elements individually but is specially designed to work in parallel processing scenarios. The difference between Iterator and Spliterator
2 min read
Java.util Package in Java
Java.util PackageIt contains the collections framework, legacy collection classes, event model, date and time facilities, internationalization, and miscellaneous utility classes (a string tokenizer, a random-number generator, and a bit array).Following are the Important Classes in Java.util package
4 min read