Interface Spliterator.OfInt

All Superinterfaces:

Spliterator<Integer>, Spliterator.OfPrimitive<Integer, IntConsumer, Spliterator.OfInt>

All Known Implementing Classes:

Spliterators.AbstractIntSpliterator

Enclosing interface:

Spliterator<T>

public static interface Spliterator.OfInt
extends Spliterator.OfPrimitive<Integer, IntConsumer, Spliterator.OfInt>

A Spliterator specialized for int values.

Since:

1.8

Nested Class Summary

Nested classes/interfaces inherited from interface Spliterator

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

Modifier and Type	Interface	Description
static interface	Spliterator.OfDouble	A Spliterator specialized for double values.
static interface	Spliterator.OfInt	A Spliterator specialized for int values.
static interface	Spliterator.OfLong	A Spliterator specialized for long values.
static interface	Spliterator.OfPrimitive<T, T_CONS, T_SPLITR extends Spliterator.OfPrimitive<T,T_CONS,T_SPLITR>>	A Spliterator specialized for primitive values.

Field Summary

Fields inherited from interface Spliterator

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

Modifier and Type	Field	Description
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.
static final int	DISTINCT	Characteristic value signifying that, for each pair of encountered elements x, y, !x.equals(y).
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.
static final int	NONNULL	Characteristic value signifying that the source guarantees that encountered elements will not be null.
static final int	ORDERED	Characteristic value signifying that an encounter order is defined for elements.
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.
static final int	SORTED	Characteristic value signifying that encounter order follows a defined sort order.
static final int	SUBSIZED	Characteristic value signifying that all Spliterators resulting from trySplit() will be both Spliterator.SIZED and Spliterator.SUBSIZED.

Method Summary

Modifier and Type	Method	Description
default void	forEachRemaining(Consumer<? super Integer> 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 void	forEachRemaining(IntConsumer 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 boolean	tryAdvance(Consumer<? super Integer> action)	If a remaining element exists: performs the given action on it, returning true; else returns false.
boolean	tryAdvance(IntConsumer action)	If a remaining element exists, performs the given action on it, returning true; else returns false.
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.

Methods inherited from interface Spliterator

characteristics, estimateSize, getComparator, getExactSizeIfKnown, hasCharacteristics

Modifier and Type	Method	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 Spliterator.forEachRemaining(Consumer) traversal, or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
default Comparator<? super Integer>	getComparator()	If this Spliterator's source is Spliterator.SORTED by a Comparator, returns that Comparator.
default long	getExactSizeIfKnown()	Convenience method that returns Spliterator.estimateSize() if this Spliterator is Spliterator.SIZED, else -1.
default boolean	hasCharacteristics(int characteristics)	Returns true if this Spliterator's Spliterator.characteristics() contain all of the given characteristics.

Method Details

trySplit

Spliterator.OfInt trySplit()

Description copied from interface: Spliterator

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.

Specified by:

trySplit in interface Spliterator<Integer>

Specified by:

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

Returns:

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

tryAdvance

boolean tryAdvance(IntConsumer action)

Description copied from interface: Spliterator.OfPrimitive

If a remaining element exists, performs the given action on it, returning true; else returns false. If this Spliterator is Spliterator.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.

Specified by:

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

Parameters:

action - The action

Returns:

false if no remaining elements existed upon entry to this method, else true.

forEachRemaining

default void forEachRemaining(IntConsumer action)

Description copied from interface: Spliterator.OfPrimitive

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

Specified by:

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

Parameters:

action - The action

tryAdvance

default boolean tryAdvance(Consumer<? super Integer> action)

If a remaining element exists: performs the given action on it, returning true; else returns false. If this Spliterator is Spliterator.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.

Specified by:

tryAdvance in interface Spliterator<Integer>

Implementation Requirements:

If the action is an instance of IntConsumer then it is cast to IntConsumer and passed to tryAdvance(java.util.function.IntConsumer); otherwise the action is adapted to an instance of IntConsumer, by boxing the argument of IntConsumer, and then passed to tryAdvance(java.util.function.IntConsumer).

Parameters:

action - The action whose operation is performed at-most once

Returns:

false if no remaining elements existed upon entry to this method, else true.

forEachRemaining

default void forEachRemaining(Consumer<? super Integer> 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 Spliterator.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.

Specified by:

forEachRemaining in interface Spliterator<Integer>

Implementation Requirements:

If the action is an instance of IntConsumer then it is cast to IntConsumer and passed to forEachRemaining(java.util.function.IntConsumer); otherwise the action is adapted to an instance of IntConsumer, by boxing the argument of IntConsumer, and then passed to forEachRemaining(java.util.function.IntConsumer).

Parameters:

action - The action