Spliterators.AbstractSpliterator

public static abstract class Spliterators.AbstractSpliterator extends Object
implements Spliterator<T>

An abstract Spliterator that implements trySplit to permit limited parallelism.

An extending class need only implement tryAdvance. The extending class should override forEach if it can provide a more performant implementation.

Inherited Constant Summary

Protected Constructor Summary

Spliterators.AbstractSpliterator(long est, int additionalCharacteristics)
Creates a spliterator reporting the given estimated size and additionalCharacteristics.

Public Method Summary

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(Consumer) traversal, or returns MAX_VALUE if infinite, unknown, or too expensive to compute.
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. This implementation permits limited parallelism.

Inherited Method Summary

Protected Constructors

protected Spliterators.AbstractSpliterator (long est, int additionalCharacteristics)

Creates a spliterator reporting the given estimated size and additionalCharacteristics.

Parameters
est the estimated size of this spliterator if known, otherwise Long.MAX_VALUE.
additionalCharacteristics properties of this spliterator's source or elements. If SIZED is reported then this spliterator will additionally report SUBSIZED.

Public Methods

public 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

public