Spliterators.AbstractIntSpliterator (FlexDoc/Javadoc 2.0 Demo)

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.

Since:

1.8

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Spliterator

Spliterator.OfDouble, Spliterator.OfInt, Spliterator.OfLong, Spliterator.OfPrimitive<T,T_CONS,T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>

Field Summary

Fields inherited from interface java.util.Spliterator

CONCURRENT, DISTINCT, IMMUTABLE, NONNULL, ORDERED, SIZED, SORTED, SUBSIZED

Constructor Summary
protected	AbstractIntSpliterator(long est, int additionalCharacteristics) Creates a spliterator reporting the given estimated size and characteristics.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Spliterator.OfInt

forEachRemaining, forEachRemaining, tryAdvance, tryAdvance

Methods inherited from interface java.util.Spliterator

getComparator, getExactSizeIfKnown, hasCharacteristics

Constructor Detail

AbstractIntSpliterator

protected AbstractIntSpliterator

(long est,
int additionalCharacteristics)

Creates a spliterator reporting the given estimated size and characteristics.

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.

Method Detail

trySplit

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

If this Spliterator is Spliterator.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.

Specified by:

trySplit in interface Spliterator.OfInt

trySplit in interface Spliterator.OfPrimitive<Integer,IntConsumer,Spliterator.OfInt>

trySplit in interface Spliterator<Integer>

Returns:

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

estimateSize

public long estimateSize

()

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

If this Spliterator is Spliterator.SIZED and has not yet been partially traversed or split, or this Spliterator is Spliterator.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 Spliterator.trySplit().

Implementation Requirements:

This implementation returns the estimated size as reported when created and, if the estimate size is known, decreases in size when split.

Specified by:

estimateSize in interface Spliterator<Integer>

Returns:

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

characteristics

public int characteristics

()

Returns a set of characteristics of this Spliterator and its elements. The result is represented as ORed values from Spliterator.ORDERED, Spliterator.DISTINCT, Spliterator.SORTED, Spliterator.SIZED, Spliterator.NONNULL, Spliterator.IMMUTABLE, Spliterator.CONCURRENT, Spliterator.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.

Implementation Requirements:

This implementation returns the characteristics as reported when created.

Specified by:

characteristics in interface Spliterator<Integer>

Returns:

a representation of characteristics

Overview

Module

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS All Classes All Packages

FRAMES NO FRAMES

FlexDoc/Javadoc 2.0
Demo Java Doc

Java API documentation generated with FlexDoc/Javadoc 2.0 using JavadocClassic 3.0 template set.

FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch, FlexDoc/Javadoc may be the only tool able to help you! Find out more at www.flexdoc.xyz