Interface Spliterator<T>

    • Field Summary

      Fields

      Modifier and Type Field and Description
      static int CONCURRENT
      Characteristic value signifying that the element source may be safely concurrently modified (allowing additions, replacements, and/or removals) by multiple threads without external synchronization.
      static int DISTINCT
      Characteristic value signifying that, for each pair of encountered elements x, y, !x.equals(y).
      static int IMMUTABLE
      Characteristic value signifying that the element source cannot be structurally modified; that is, elements cannot be added, replaced, or removed, so such changes cannot occur during traversal.
      static int NONNULL
      Characteristic value signifying that the source guarantees that encountered elements will not be null.
      static int ORDERED
      Characteristic value signifying that an encounter order is defined for elements.
      static int SIZED
      Characteristic value signifying that the value returned from estimateSize() prior to traversal or splitting represents a finite size that, in the absence of structural source modification, represents an exact count of the number of elements that would be encountered by a complete traversal.
      static int SORTED
      Characteristic value signifying that encounter order follows a defined sort order.
      static int SUBSIZED
      Characteristic value signifying that all Spliterators resulting from trySplit() will be both SIZED and SUBSIZED.
    • Method Summary

      Modifier and Type Method and Description
      int characteristics()
      Returns a set of characteristics of this Spliterator and its elements.
      long estimateSize()
      Returns an estimate of the number of elements that would be encountered by a forEachRemaining(java.util.function.Consumer<? super T>) traversal, or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
      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.
      default Comparator<? super T> getComparator()
      If this Spliterator's source is SORTED by a Comparator, returns that Comparator.
      default long getExactSizeIfKnown()
      Convenience method that returns estimateSize() if this Spliterator is SIZED, else -1.
      default boolean hasCharacteristics(int characteristics)
      Returns true if this Spliterator's characteristics() contain all of the given characteristics.
      boolean tryAdvance(Consumer<? super T> action)
      If a remaining element exists, performs the given action on it, returning true; else returns false.
      Spliterator<T> trySplit()
      If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.
    • Field Detail

      • DISTINCT

        static final int DISTINCT
        Characteristic value signifying that, for each pair of encountered elements x, y, !x.equals(y). This applies for example, to a Spliterator based on a Set.
        See Also:
        Constant Field Values
      • SORTED

        static final int SORTED
        Characteristic value signifying that encounter order follows a defined sort order. If so, method getComparator() returns the associated Comparator, or null if all elements are Comparable and are sorted by their natural ordering.

        A Spliterator that reports SORTED must also report ORDERED.

        See Also:
        Constant Field Values
      • SIZED

        static final int SIZED
        Characteristic value signifying that the value returned from estimateSize() prior to traversal or splitting represents a finite size that, in the absence of structural source modification, represents an exact count of the number of elements that would be encountered by a complete traversal.
        See Also:
        Constant Field Values
      • NONNULL

        static final int NONNULL
        Characteristic value signifying that the source guarantees that encountered elements will not be null. (This applies, for example, to most concurrent collections, queues, and maps.)
        See Also:
        Constant Field Values
      • IMMUTABLE

        static final int IMMUTABLE
        Characteristic value signifying that the element source cannot be structurally modified; that is, elements cannot be added, replaced, or removed, so such changes cannot occur during traversal. A Spliterator that does not report IMMUTABLE or CONCURRENT is expected to have a documented policy (for example throwing ConcurrentModificationException) concerning structural interference detected during traversal.
        See Also:
        Constant Field Values
      • CONCURRENT

        static final int CONCURRENT
        Characteristic value signifying that the element source may be safely concurrently modified (allowing additions, replacements, and/or removals) by multiple threads without external synchronization. If so, the Spliterator is expected to have a documented policy concerning the impact of modifications during traversal.

        A top-level Spliterator should not report both CONCURRENT and SIZED, since the finite size, if known, may change if the source is concurrently modified during traversal. Such a Spliterator is inconsistent and no guarantees can be made about any computation using that Spliterator. Sub-spliterators may report SIZED if the sub-split size is known and additions or removals to the source are not reflected when traversing.

        See Also:
        Constant Field Values
      • SUBSIZED

        static final int SUBSIZED
        Characteristic value signifying that all Spliterators resulting from trySplit() will be both SIZED and SUBSIZED. (This means that all child Spliterators, whether direct or indirect, will be SIZED.)

        A Spliterator that does not report SIZED as required by SUBSIZED is inconsistent and no guarantees can be made about any computation using that Spliterator.

        See Also:
        Constant Field Values
    • Method Detail

      • tryAdvance

        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.
        Parameters:
        action - The action
        Returns:
        false if no remaining elements existed upon entry to this method, else true.
        Throws:
        NullPointerException - if the specified action is null
      • forEachRemaining

        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.
        Parameters:
        action - The action
        Throws:
        NullPointerException - if the specified action is null
      • trySplit

        Spliterator<T> trySplit()
        If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.

        If this Spliterator is ORDERED, the returned Spliterator must cover a strict prefix of the elements.

        Unless this Spliterator covers an infinite number of elements, repeated calls to trySplit() must eventually return null. Upon non-null return:

        • the value reported for estimateSize() before splitting, must, after splitting, be greater than or equal to estimateSize() for this and the returned Spliterator; and
        • if this Spliterator is SUBSIZED, then estimateSize() for this spliterator before splitting must be equal to the sum of estimateSize() for this and the returned Spliterator after splitting.

        This method may return null for any reason, including emptiness, inability to split after traversal has commenced, data structure constraints, and efficiency considerations.

        Returns:
        a Spliterator covering some portion of the elements, or null if this spliterator cannot be split
      • estimateSize

        long estimateSize()
        Returns an estimate of the number of elements that would be encountered by a forEachRemaining(java.util.function.Consumer<? super T>) traversal, or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.

        If this Spliterator is SIZED and has not yet been partially traversed or split, or this Spliterator is SUBSIZED and has not yet been partially traversed, this estimate must be an accurate count of elements that would be encountered by a complete traversal. Otherwise, this estimate may be arbitrarily inaccurate, but must decrease as specified across invocations of trySplit().

        Returns:
        the estimated size, or Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
      • getExactSizeIfKnown

        default long getExactSizeIfKnown()
        Convenience method that returns estimateSize() if this Spliterator is SIZED, else -1.
        Returns:
        the exact size, if known, else -1.
      • characteristics

        int characteristics()
        Returns a set of characteristics of this Spliterator and its elements. The result is represented as ORed values from ORDERED, DISTINCT, SORTED, SIZED, NONNULL, IMMUTABLE, CONCURRENT, SUBSIZED. Repeated calls to characteristics() on a given spliterator, prior to or in-between calls to trySplit, should always return the same result.

        If a Spliterator reports an inconsistent set of characteristics (either those returned from a single invocation or across multiple invocations), no guarantees can be made about any computation using this Spliterator.

        Returns:
        a representation of characteristics
      • hasCharacteristics

        default boolean hasCharacteristics(int characteristics)
        Returns true if this Spliterator's characteristics() contain all of the given characteristics.
        Parameters:
        characteristics - the characteristics to check for
        Returns:
        true if all the specified characteristics are present, else false
      • getComparator

        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.
        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.