Spliterators (net.sourceforge.streamsupport:streamsupport 1.3 API)

java.lang.Object
- java8.util.Spliterators

```
public final class Spliterators
extends Object
```
Static classes and methods for operating on or creating instances of Spliterator and its primitive specializations Spliterator.OfInt, Spliterator.OfLong, and Spliterator.OfDouble.

Since:

1.8

See Also:

Spliterator

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Spliterators.AbstractDoubleSpliterator` An abstract `Spliterator.OfDouble` that implements `trySplit` to permit limited parallelism.
`static class`	`Spliterators.AbstractIntSpliterator` An abstract `Spliterator.OfInt` that implements `trySplit` to permit limited parallelism.
`static class`	`Spliterators.AbstractLongSpliterator` An abstract `Spliterator.OfLong` that implements `trySplit` to permit limited parallelism.
`static class`	`Spliterators.AbstractSpliterator<T>` An abstract `Spliterator` that implements `trySplit` to permit limited parallelism.
`static class`	`Spliterators.OfDouble` Static default implementations for the Java 8 default methods of `Spliterator.OfDouble`
`static class`	`Spliterators.OfInt` Static default implementations for the Java 8 default methods of `Spliterator.OfInt`
`static class`	`Spliterators.OfLong` Static default implementations for the Java 8 default methods of `Spliterator.OfLong`
`static class`	`Spliterators.OfPrimitive` Static default implementations for the Java 8 default method of `Spliterator.OfPrimitive`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Spliterator.OfDouble`	`emptyDoubleSpliterator()` Creates an empty `Spliterator.OfDouble` The empty spliterator reports `Spliterator.SIZED` and `Spliterator.SUBSIZED`.
`static Spliterator.OfInt`	`emptyIntSpliterator()` Creates an empty `Spliterator.OfInt` The empty spliterator reports `Spliterator.SIZED` and `Spliterator.SUBSIZED`.
`static Spliterator.OfLong`	`emptyLongSpliterator()` Creates an empty `Spliterator.OfLong` The empty spliterator reports `Spliterator.SIZED` and `Spliterator.SUBSIZED`.
`static <T> Spliterator<T>`	`emptySpliterator()` Creates an empty `Spliterator` The empty spliterator reports `Spliterator.SIZED` and `Spliterator.SUBSIZED`.
`static <T> void`	`forEachRemaining(Spliterator<T> this_, 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.
`static <T> Comparator<? super T>`	`getComparator(Spliterator<T> this_)` If the Spliterator's source is `Spliterator.SORTED` by a `Comparator`, returns that `Comparator`.
`static <T> long`	`getExactSizeIfKnown(Spliterator<T> this_)` Convenience method that returns `Spliterator.estimateSize()` if the `this_` Spliterator is `Spliterator.SIZED`, else `-1`.
`static <T> boolean`	`hasCharacteristics(Spliterator<T> this_, int characteristics)` Returns `true` if the `this_` Spliterator's `Spliterator.characteristics()` contain all of the given characteristics.
`static PrimitiveIterator.OfDouble`	`iterator(Spliterator.OfDouble spliterator)` Creates an `PrimitiveIterator.OfDouble` from a `Spliterator.OfDouble`.
`static PrimitiveIterator.OfInt`	`iterator(Spliterator.OfInt spliterator)` Creates an `PrimitiveIterator.OfInt` from a `Spliterator.OfInt`.
`static PrimitiveIterator.OfLong`	`iterator(Spliterator.OfLong spliterator)` Creates an `PrimitiveIterator.OfLong` from a `Spliterator.OfLong`.
`static <T> Iterator<T>`	`iterator(Spliterator<? extends T> spliterator)` Creates an `Iterator` from a `Spliterator`.
`static <T> Spliterator<T>`	`spliterator(Collection<? extends T> c)` Creates either a specialized `Spliterator` (effectively the same one that Java 8 uses) for the given collection provided it is one of the types listed below or a `Spliterator` using the given collection's `Collection.iterator()` as the source of elements, and reporting its `Collection.size()` as its initial size.
`static <T> Spliterator<T>`	`spliterator(Collection<? extends T> c, int characteristics)` Creates a `Spliterator` using the given collection's `Collection.iterator()` as the source of elements, and reporting its `Collection.size()` as its initial size.
`static Spliterator.OfDouble`	`spliterator(double[] array, int additionalCharacteristics)` Creates a `Spliterator.OfDouble` covering the elements of a given array, using a customized set of spliterator characteristics.
`static Spliterator.OfDouble`	`spliterator(double[] array, int fromIndex, int toIndex, int additionalCharacteristics)` Creates a `Spliterator.OfDouble` covering a range of elements of a given array, using a customized set of spliterator characteristics.
`static Spliterator.OfInt`	`spliterator(int[] array, int additionalCharacteristics)` Creates a `Spliterator.OfInt` covering the elements of a given array, using a customized set of spliterator characteristics.
`static Spliterator.OfInt`	`spliterator(int[] array, int fromIndex, int toIndex, int additionalCharacteristics)` Creates a `Spliterator.OfInt` covering a range of elements of a given array, using a customized set of spliterator characteristics.
`static <T> Spliterator<T>`	`spliterator(Iterator<? extends T> iterator, long size, int characteristics)` Creates a `Spliterator` using a given `Iterator` as the source of elements, and with a given initially reported size.
`static Spliterator.OfLong`	`spliterator(long[] array, int additionalCharacteristics)` Creates a `Spliterator.OfLong` covering the elements of a given array, using a customized set of spliterator characteristics.
`static Spliterator.OfLong`	`spliterator(long[] array, int fromIndex, int toIndex, int additionalCharacteristics)` Creates a `Spliterator.OfLong` covering a range of elements of a given array, using a customized set of spliterator characteristics.
`static <T> Spliterator<T>`	`spliterator(Object[] array, int additionalCharacteristics)` Creates a `Spliterator` covering the elements of a given array, using a customized set of spliterator characteristics.
`static <T> Spliterator<T>`	`spliterator(Object[] array, int fromIndex, int toIndex, int additionalCharacteristics)` Creates a `Spliterator` covering a range of elements of a given array, using a customized set of spliterator characteristics.
`static Spliterator.OfDouble`	`spliterator(PrimitiveIterator.OfDouble iterator, long size, int characteristics)` Creates a `Spliterator.OfDouble` using a given `DoubleStream.DoubleIterator` as the source of elements, and with a given initially reported size.
`static Spliterator.OfInt`	`spliterator(PrimitiveIterator.OfInt iterator, long size, int characteristics)` Creates a `Spliterator.OfInt` using a given `IntStream.IntIterator` as the source of elements, and with a given initially reported size.
`static Spliterator.OfLong`	`spliterator(PrimitiveIterator.OfLong iterator, long size, int characteristics)` Creates a `Spliterator.OfLong` using a given `LongStream.LongIterator` as the source of elements, and with a given initially reported size.
`static <T> Spliterator<T>`	`spliteratorUnknownSize(Iterator<? extends T> iterator, int characteristics)` Creates a `Spliterator` using a given `Iterator` as the source of elements, with no initial size estimate.
`static Spliterator.OfDouble`	`spliteratorUnknownSize(PrimitiveIterator.OfDouble iterator, int characteristics)` Creates a `Spliterator.OfDouble` using a given `DoubleStream.DoubleIterator` as the source of elements, with no initial size estimate.
`static Spliterator.OfInt`	`spliteratorUnknownSize(PrimitiveIterator.OfInt iterator, int characteristics)` Creates a `Spliterator.OfInt` using a given `IntStream.IntIterator` as the source of elements, with no initial size estimate.
`static Spliterator.OfLong`	`spliteratorUnknownSize(PrimitiveIterator.OfLong iterator, int characteristics)` Creates a `Spliterator.OfLong` using a given `LongStream.LongIterator` as the source of elements, with no initial size estimate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - forEachRemaining
```
public static <T> void forEachRemaining(Spliterator<T> this_,
                                        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 the this_ Spliterator is Spliterator.ORDERED, actions are performed in encounter order. Exceptions thrown by the action are relayed to the caller.
    Implementation Requirements:
    The default implementation repeatedly invokes Spliterator.tryAdvance(java8.util.function.Consumer<? super T>) until it returns false. It should be overridden whenever possible.
    
    Type Parameters:
    
    T - the type of elements returned by the passed Spliterator
    
    Parameters:
    
    this_ - the Spliterator whose remaining elements should be processed
    
    action - The action
    
    Throws:
    
    NullPointerException - if the specified action is null
  - getExactSizeIfKnown
```
public static <T> long getExactSizeIfKnown(Spliterator<T> this_)
```
    Convenience method that returns Spliterator.estimateSize() if the this_ Spliterator is Spliterator.SIZED, else -1.
    Implementation Requirements:
    The default implementation returns the result of estimateSize() if the Spliterator reports a characteristic of Spliterator#SIZED, and -1 otherwise.
    
    Type Parameters:
    
    T - the type of elements returned by the passed Spliterator
    
    Parameters:
    
    this_ - the Spliterator whose exact size should be queried
    
    Returns:
    
    the exact size, if known, else -1.
  - hasCharacteristics
```
public static <T> boolean hasCharacteristics(Spliterator<T> this_,
                                             int characteristics)
```
    Returns true if the this_ Spliterator's Spliterator.characteristics() contain all of the given characteristics.
    Implementation Requirements:
    The default implementation returns true if the corresponding bits of the given characteristics are set.
    
    Type Parameters:
    
    T - the type of elements returned by the passed Spliterator
    
    Parameters:
    
    this_ - the Spliterator whose characteristics should be queried
    
    characteristics - the characteristics to check for
    
    Returns:
    
    true if all the specified characteristics are present, else false
  - getComparator
```
public static <T> Comparator<? super T> getComparator(Spliterator<T> this_)
```
    If the Spliterator's source is Spliterator.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.
    Implementation Requirements:
    The default implementation always throws IllegalStateException.
    
    Type Parameters:
    
    T - the type of elements returned by the passed Spliterator
    
    Parameters:
    
    this_ - the Spliterator for which a Comparator is requested
    
    Returns:
    
    a Comparator, or null if the elements are sorted in the natural order.
    
    Throws:
    
    IllegalStateException - if the spliterator does not report a characteristic of SORTED.
  - emptySpliterator
```
public static <T> Spliterator<T> emptySpliterator()
```
    Creates an empty Spliterator
    The empty spliterator reports Spliterator.SIZED and Spliterator.SUBSIZED. Calls to Spliterator.trySplit() always return null.
    
    Type Parameters:
    
    T - Type of elements
    
    Returns:
    
    An empty spliterator
  - emptyIntSpliterator
```
public static Spliterator.OfInt emptyIntSpliterator()
```
    Creates an empty Spliterator.OfInt
    The empty spliterator reports Spliterator.SIZED and Spliterator.SUBSIZED. Calls to Spliterator.trySplit() always return null.
    
    Returns:
    
    An empty spliterator
  - emptyLongSpliterator
```
public static Spliterator.OfLong emptyLongSpliterator()
```
    Creates an empty Spliterator.OfLong
    The empty spliterator reports Spliterator.SIZED and Spliterator.SUBSIZED. Calls to Spliterator.trySplit() always return null.
    
    Returns:
    
    An empty spliterator
  - emptyDoubleSpliterator
```
public static Spliterator.OfDouble emptyDoubleSpliterator()
```
    Creates an empty Spliterator.OfDouble
    The empty spliterator reports Spliterator.SIZED and Spliterator.SUBSIZED. Calls to Spliterator.trySplit() always return null.
    
    Returns:
    
    An empty spliterator
  - spliterator
```
public static <T> Spliterator<T> spliterator(Object[] array,
                                             int additionalCharacteristics)
```
    Creates a Spliterator covering the elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(Object[]).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.
    
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    See Also:
    
    Arrays.spliterator(Object[])
  - spliterator
```
public static <T> Spliterator<T> spliterator(Object[] array,
                                             int fromIndex,
                                             int toIndex,
                                             int additionalCharacteristics)
```
    Creates a Spliterator covering a range of elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(Object[]).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.
    
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    fromIndex - The least index (inclusive) to cover
    
    toIndex - One past the greatest index to cover
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    ArrayIndexOutOfBoundsException - if fromIndex is negative, toIndex is less than fromIndex, or toIndex is greater than the array size
    
    See Also:
    
    Arrays.spliterator(Object[], int, int)
  - spliterator
```
public static Spliterator.OfInt spliterator(int[] array,
                                            int additionalCharacteristics)
```
    Creates a Spliterator.OfInt covering the elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(int[]).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    See Also:
    
    Arrays.spliterator(int[])
  - spliterator
```
public static Spliterator.OfInt spliterator(int[] array,
                                            int fromIndex,
                                            int toIndex,
                                            int additionalCharacteristics)
```
    Creates a Spliterator.OfInt covering a range of elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(int[], int, int).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    fromIndex - The least index (inclusive) to cover
    
    toIndex - One past the greatest index to cover
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    ArrayIndexOutOfBoundsException - if fromIndex is negative, toIndex is less than fromIndex, or toIndex is greater than the array size
    
    See Also:
    
    Arrays.spliterator(int[], int, int)
  - spliterator
```
public static Spliterator.OfLong spliterator(long[] array,
                                             int additionalCharacteristics)
```
    Creates a Spliterator.OfLong covering the elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(long[]).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    See Also:
    
    Arrays.spliterator(long[])
  - spliterator
```
public static Spliterator.OfLong spliterator(long[] array,
                                             int fromIndex,
                                             int toIndex,
                                             int additionalCharacteristics)
```
    Creates a Spliterator.OfLong covering a range of elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(long[], int, int).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report. (For example, if it is known the array will not be further modified, specify IMMUTABLE; if the array data is considered to have an an encounter order, specify ORDERED). The method Arrays.spliterator(long[], int, int) can often be used instead, which returns a spliterator that reports SIZED, SUBSIZED, IMMUTABLE, and ORDERED.
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    fromIndex - The least index (inclusive) to cover
    
    toIndex - One past the greatest index to cover
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    ArrayIndexOutOfBoundsException - if fromIndex is negative, toIndex is less than fromIndex, or toIndex is greater than the array size
    
    See Also:
    
    Arrays.spliterator(long[], int, int)
  - spliterator
```
public static Spliterator.OfDouble spliterator(double[] array,
                                               int additionalCharacteristics)
```
    Creates a Spliterator.OfDouble covering the elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(double[]).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report; it is common to additionally specify IMMUTABLE and ORDERED.
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    See Also:
    
    Arrays.spliterator(double[])
  - spliterator
```
public static Spliterator.OfDouble spliterator(double[] array,
                                               int fromIndex,
                                               int toIndex,
                                               int additionalCharacteristics)
```
    Creates a Spliterator.OfDouble covering a range of elements of a given array, using a customized set of spliterator characteristics.
    This method is provided as an implementation convenience for Spliterators which store portions of their elements in arrays, and need fine control over Spliterator characteristics. Most other situations in which a Spliterator for an array is needed should use Arrays.spliterator(double[], int, int).
    The returned spliterator always reports the characteristics SIZED and SUBSIZED. The caller may provide additional characteristics for the spliterator to report. (For example, if it is known the array will not be further modified, specify IMMUTABLE; if the array data is considered to have an an encounter order, specify ORDERED). The method Arrays.spliterator(long[], int, int) can often be used instead, which returns a spliterator that reports SIZED, SUBSIZED, IMMUTABLE, and ORDERED.
    
    Parameters:
    
    array - The array, assumed to be unmodified during use
    
    fromIndex - The least index (inclusive) to cover
    
    toIndex - One past the greatest index to cover
    
    additionalCharacteristics - Additional spliterator characteristics of this spliterator's source or elements beyond SIZED and SUBSIZED which are are always reported
    
    Returns:
    
    A spliterator for an array
    
    Throws:
    
    NullPointerException - if the given array is null
    
    ArrayIndexOutOfBoundsException - if fromIndex is negative, toIndex is less than fromIndex, or toIndex is greater than the array size
    
    See Also:
    
    Arrays.spliterator(double[], int, int)
  - spliterator
```
public static <T> Spliterator<T> spliterator(Collection<? extends T> c)
```
    Creates either a specialized Spliterator (effectively the same one that Java 8 uses) for the given collection provided it is one of the types listed below or a Spliterator using the given collection's Collection.iterator() as the source of elements, and reporting its Collection.size() as its initial size.
    In the latter case, if the given collection implements one of the interfaces List, Set or SortedSet the returned Spliterator will resemble the corresponding interface default implementation of the respective spliterator() method from Java 8. Otherwise the Java 8 default implementation of java.util.Collection.spliterator() is used (which is essentially the same as calling spliterator(Collection, int) with a characteristics value equal to 0).
    Currently, the collections that have specializations available are the following:
    - java.util.ArrayList
    - java.util.Arrays.ArrayList
    - java.util.ArrayDeque
    - java.util.Vector
    - java.util.LinkedList
    - java.util.HashSet
    - java.util.LinkedHashSet
    - java.util.PriorityQueue
    - java.util.concurrent.ArrayBlockingQueue
    - java.util.concurrent.LinkedBlockingQueue
    - java.util.concurrent.LinkedBlockingDeque
    - java.util.concurrent.PriorityBlockingQueue
    - java.util.concurrent.CopyOnWriteArrayList
    - java.util.concurrent.CopyOnWriteArraySet
    - The collections returned from the java.util.HashMap methods #keySet(), #entrySet() and #values()
    The Spliterators for CopyOnWriteArrayList and CopyOnWriteArraySet provide a snapshot of the state of the collection when the Spliterator was created, otherwise the spliterator is late-binding, inherits the fail-fast properties of the collection's iterator, and implements trySplit to permit limited parallelism.
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    c - The collection
    
    Returns:
    
    Either a specialized spliterator if the given collection is one of the types listed above or a spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given collection is null
  - spliterator
```
public static <T> Spliterator<T> spliterator(Collection<? extends T> c,
                                             int characteristics)
```
    Creates a Spliterator using the given collection's Collection.iterator() as the source of elements, and reporting its Collection.size() as its initial size.
    The spliterator is late-binding, inherits the fail-fast properties of the collection's iterator, and implements trySplit to permit limited parallelism.
    
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    c - The collection
    
    characteristics - Characteristics of this spliterator's source or elements. The characteristics SIZED and SUBSIZED are additionally reported unless CONCURRENT is supplied.
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given collection is null
  - spliterator
```
public static <T> Spliterator<T> spliterator(Iterator<? extends T> iterator,
                                             long size,
                                             int characteristics)
```
    Creates a Spliterator using a given Iterator as the source of elements, and with a given initially reported size.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.
    
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    iterator - The iterator for the source
    
    size - The number of elements in the source, to be reported as initial estimateSize
    
    characteristics - Characteristics of this spliterator's source or elements. The characteristics SIZED and SUBSIZED are additionally reported unless CONCURRENT is supplied.
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliteratorUnknownSize
```
public static <T> Spliterator<T> spliteratorUnknownSize(Iterator<? extends T> iterator,
                                                        int characteristics)
```
    Creates a Spliterator using a given Iterator as the source of elements, with no initial size estimate.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.
    
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    iterator - The iterator for the source
    
    characteristics - Characteristics of this spliterator's source or elements (SIZED and SUBSIZED, if supplied, are ignored and are not reported.)
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliterator
```
public static Spliterator.OfInt spliterator(PrimitiveIterator.OfInt iterator,
                                            long size,
                                            int characteristics)
```
    Creates a Spliterator.OfInt using a given IntStream.IntIterator as the source of elements, and with a given initially reported size.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.
    
    Parameters:
    
    iterator - The iterator for the source
    
    size - The number of elements in the source, to be reported as initial estimateSize.
    
    characteristics - Characteristics of this spliterator's source or elements. The characteristics SIZED and SUBSIZED are additionally reported unless CONCURRENT is supplied.
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliteratorUnknownSize
```
public static Spliterator.OfInt spliteratorUnknownSize(PrimitiveIterator.OfInt iterator,
                                                       int characteristics)
```
    Creates a Spliterator.OfInt using a given IntStream.IntIterator as the source of elements, with no initial size estimate.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.
    
    Parameters:
    
    iterator - The iterator for the source
    
    characteristics - Characteristics of this spliterator's source or elements (SIZED and SUBSIZED, if supplied, are ignored and are not reported.)
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliterator
```
public static Spliterator.OfLong spliterator(PrimitiveIterator.OfLong iterator,
                                             long size,
                                             int characteristics)
```
    Creates a Spliterator.OfLong using a given LongStream.LongIterator as the source of elements, and with a given initially reported size.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.
    
    Parameters:
    
    iterator - The iterator for the source
    
    size - The number of elements in the source, to be reported as initial estimateSize.
    
    characteristics - Characteristics of this spliterator's source or elements. The characteristics SIZED and SUBSIZED are additionally reported unless CONCURRENT is supplied.
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliteratorUnknownSize
```
public static Spliterator.OfLong spliteratorUnknownSize(PrimitiveIterator.OfLong iterator,
                                                        int characteristics)
```
    Creates a Spliterator.OfLong using a given LongStream.LongIterator as the source of elements, with no initial size estimate.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.
    
    Parameters:
    
    iterator - The iterator for the source
    
    characteristics - Characteristics of this spliterator's source or elements (SIZED and SUBSIZED, if supplied, are ignored and are not reported.)
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliterator
```
public static Spliterator.OfDouble spliterator(PrimitiveIterator.OfDouble iterator,
                                               long size,
                                               int characteristics)
```
    Creates a Spliterator.OfDouble using a given DoubleStream.DoubleIterator as the source of elements, and with a given initially reported size.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned, or the initially reported size is not equal to the actual number of elements in the source.
    
    Parameters:
    
    iterator - The iterator for the source
    
    size - The number of elements in the source, to be reported as initial estimateSize
    
    characteristics - Characteristics of this spliterator's source or elements. The characteristics SIZED and SUBSIZED are additionally reported unless CONCURRENT is supplied.
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - spliteratorUnknownSize
```
public static Spliterator.OfDouble spliteratorUnknownSize(PrimitiveIterator.OfDouble iterator,
                                                          int characteristics)
```
    Creates a Spliterator.OfDouble using a given DoubleStream.DoubleIterator as the source of elements, with no initial size estimate.
    The spliterator is not late-binding, inherits the fail-fast properties of the iterator, and implements trySplit to permit limited parallelism.
    Traversal of elements should be accomplished through the spliterator. The behaviour of splitting and traversal is undefined if the iterator is operated on after the spliterator is returned.
    
    Parameters:
    
    iterator - The iterator for the source
    
    characteristics - Characteristics of this spliterator's source or elements (SIZED and SUBSIZED, if supplied, are ignored and are not reported.)
    
    Returns:
    
    A spliterator from an iterator
    
    Throws:
    
    NullPointerException - if the given iterator is null
  - iterator
```
public static <T> Iterator<T> iterator(Spliterator<? extends T> spliterator)
```
    Creates an Iterator from a Spliterator.
    Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.
    
    Type Parameters:
    
    T - Type of elements
    
    Parameters:
    
    spliterator - The spliterator
    
    Returns:
    
    An iterator
    
    Throws:
    
    NullPointerException - if the given spliterator is null
  - iterator
```
public static PrimitiveIterator.OfInt iterator(Spliterator.OfInt spliterator)
```
    Creates an PrimitiveIterator.OfInt from a Spliterator.OfInt.
    Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.
    
    Parameters:
    
    spliterator - The spliterator
    
    Returns:
    
    An iterator
    
    Throws:
    
    NullPointerException - if the given spliterator is null
  - iterator
```
public static PrimitiveIterator.OfLong iterator(Spliterator.OfLong spliterator)
```
    Creates an PrimitiveIterator.OfLong from a Spliterator.OfLong.
    Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.
    
    Parameters:
    
    spliterator - The spliterator
    
    Returns:
    
    An iterator
    
    Throws:
    
    NullPointerException - if the given spliterator is null
  - iterator
```
public static PrimitiveIterator.OfDouble iterator(Spliterator.OfDouble spliterator)
```
    Creates an PrimitiveIterator.OfDouble from a Spliterator.OfDouble.
    Traversal of elements should be accomplished through the iterator. The behaviour of traversal is undefined if the spliterator is operated after the iterator is returned.
    
    Parameters:
    
    spliterator - The spliterator
    
    Returns:
    
    An iterator
    
    Throws:
    
    NullPointerException - if the given spliterator is null

Class Spliterators

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

forEachRemaining

getExactSizeIfKnown

hasCharacteristics

getComparator

emptySpliterator

emptyIntSpliterator

emptyLongSpliterator

emptyDoubleSpliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliterator

spliteratorUnknownSize

spliterator

spliteratorUnknownSize

spliterator

spliteratorUnknownSize

spliterator

spliteratorUnknownSize

iterator

iterator

iterator

iterator