Added in API level 24

AbstractSpliterator

abstract class AbstractSpliterator<T : Any!> : Spliterator<T>
kotlin.Any
   ↳ java.util.Spliterators.AbstractSpliterator

An abstract Spliterator that implements trySplit to permit limited parallelism.

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

Summary

Inherited constants
Protected constructors
AbstractSpliterator(est: Long, additionalCharacteristics: Int)

Creates a spliterator reporting the given estimated size and additionalCharacteristics.

Public methods
open Int

Returns a set of characteristics of this Spliterator and its elements.

open Long

Returns an estimate of the number of elements that would be encountered by a forEachRemaining traversal, or returns java.lang.Long#MAX_VALUE if infinite, unknown, or too expensive to compute.

open Spliterator<T>!

If this spliterator can be partitioned, returns a Spliterator covering elements, that will, upon return from this method, not be covered by this Spliterator.

Inherited functions

Protected constructors

AbstractSpliterator

Added in API level 24
protected AbstractSpliterator(
    est: Long,
    additionalCharacteristics: Int)

Creates a spliterator reporting the given estimated size and additionalCharacteristics.

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

Public methods

characteristics

Added in API level 24
open fun characteristics(): Int

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.

Return
Int a representation of characteristics

estimateSize

Added in API level 24
open fun estimateSize(): Long

Returns an estimate of the number of elements that would be encountered by a forEachRemaining traversal, or returns java.lang.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.

Return
Long the estimated size, or Long.MAX_VALUE if infinite, unknown, or too expensive to compute.

trySplit

Added in API level 24
open fun trySplit(): Spliterator<T>!

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. This implementation permits limited parallelism.

Return
Spliterator<T>! a Spliterator covering some portion of the elements, or null if this spliterator cannot be split