Spliterator.OfInt

AI-generated Key Takeaways

• Spliterator.OfInt is a specialized interface for processing int values, extending the capabilities of the Spliterator interface for primitive types.

• It provides methods like tryAdvance, forEachRemaining, and trySplit to traverse and potentially split the source of int elements.

• This interface inherits several characteristics from its parent interfaces, such as ORDERED, SIZED, IMMUTABLE, indicating properties of the data source.

• Spliterator.OfInt allows efficient and potentially parallel processing of streams of integer data by enabling operations on individual elements and partitioning the data for parallel execution.

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

Known Indirect Subclasses Spliterators.AbstractIntSpliterator Spliterators.AbstractIntSpliterator An abstract Spliterator.OfInt that implements trySplit to permit limited parallelism.

A Spliterator specialized for int values.

Inherited Constant Summary

From interface java.util.Spliterator

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

Public Method Summary

void	forEachRemaining(Consumer<? super Integer> action)
void	forEachRemaining(IntConsumer action)
boolean	tryAdvance(Consumer<? super Integer> action)
abstract boolean	tryAdvance(IntConsumer action)
abstract 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 Method Summary

From interface java.util.Spliterator.OfPrimitive

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.
abstract boolean	tryAdvance(IntConsumer action) If a remaining element exists, performs the given action on it, returning true; else returns false.
abstract T_SPLITR	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.

From interface java.util.Spliterator

abstract int	characteristics() Returns a set of characteristics of this Spliterator and its elements.
abstract long	estimateSize() Returns an estimate of the number of elements that would be encountered by a forEachRemaining(Consumer) traversal, or returns Long.MAX_VALUE if infinite, unknown, or too expensive to compute.
void	forEachRemaining(Consumer<? super T> 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.
Comparator<? super T>	getComparator() If this Spliterator's source is SORTED by a Comparator, returns that Comparator.
long	getExactSizeIfKnown() Convenience method that returns estimateSize() if this Spliterator is SIZED, else -1.
boolean	hasCharacteristics(int characteristics) Returns true if this Spliterator's characteristics() contain all of the given characteristics.
abstract boolean	tryAdvance(Consumer<? super T> action) If a remaining element exists, performs the given action on it, returning true; else returns false.
abstract Spliterator<Integer>	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.

Public Methods

public void forEachRemaining (Consumer<? super Integer> action)

Parameters

action

public void forEachRemaining (IntConsumer action)

Parameters

action

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

Parameters

action

public abstract boolean tryAdvance (IntConsumer action)

Parameters

action

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

Returns

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