Added in API level 24

AbstractIntSpliterator

abstract class AbstractIntSpliterator : Spliterator.OfInt

kotlin.Any
	java.util.Spliterators.AbstractIntSpliterator

An abstract Spliterator.OfInt that implements trySplit to permit limited parallelism.

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

Summary

Protected constructors
`AbstractIntSpliterator(est: Long, additionalCharacteristics: Int)` Creates a spliterator reporting the given estimated size and characteristics.

Public methods
open Int	`characteristics()` Returns a set of characteristics of this Spliterator and its elements.
open Long	`estimateSize()` Returns an estimate of the number of elements that would be encountered by a `forEachRemaining` traversal, or returns `Long.MAX_VALUE` if infinite, unknown, or too expensive to compute.
open Spliterator.OfInt!	`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.

Inherited functions

From class OfInt

`Unit`	`forEachRemaining(action: Consumer<in Int!>!)` 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. Subsequent behavior of a spliterator is unspecified if the action throws an exception.
`Unit`	`forEachRemaining(action: IntConsumer!)` 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. Subsequent behavior of a spliterator is unspecified if the action throws an exception.
`Boolean`	`tryAdvance(action: Consumer<in Int!>!)` 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. Subsequent behavior of a spliterator is unspecified if the action throws an exception.
`Boolean`	`tryAdvance(action: IntConsumer!)` 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. Subsequent behavior of a spliterator is unspecified if the action throws an exception.

Protected constructors

AbstractIntSpliterator

Added in API level 24

protected AbstractIntSpliterator(
    est: Long, 
    additionalCharacteristics: Int)

Creates a spliterator reporting the given estimated size and characteristics.

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

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.OfInt!`	a `Spliterator` covering some portion of the elements, or `null` if this spliterator cannot be split

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

AbstractIntSpliterator

Summary

Protected constructors

AbstractIntSpliterator

Public methods

characteristics

estimateSize

trySplit

More Android

Discover

Android Devices

Releases

Documentation and Downloads

Support