Class IntegerList.PrimitiveSpliterator

java.lang.Object

org.apache.sis.util.collection.IntegerList.PrimitiveSpliterator

All Implemented Interfaces:

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

Enclosing class:

IntegerList

private final class IntegerList.PrimitiveSpliterator
extends Object
implements Spliterator.OfInt, PrimitiveIterator.OfInt

Same as IntegerList.spliterator(), but without value boxing. This spliterator provides a fail-fast way to traverse list content, which means that any alteration to the list content causes a failure of the advance operation with a ConcurrentModificationException.

This implementation opportunistically provides an iterator implementation on integer values too, but only one of the Iterator or Spliterator API should be used on a given instance.

Since:

0.7

Version:

1.1

Nested Class Summary

Nested classes/interfaces inherited from interface PrimitiveIterator

PrimitiveIterator.OfDouble, PrimitiveIterator.OfInt, PrimitiveIterator.OfLong

Nested classes/interfaces inherited from interface Spliterator

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

Field Summary

Fields

Modifier and Type	Field	Description
private int	expectedModCount	The AbstractList.modCount value as iterator construction time.
private int	lastRemove	Index of the last elements removed by a remove() operation.
private int	nextIndex	Index of the next element to be returned.
private int	stopAt	Index after the last element returned by this spliterator.

Fields inherited from interface Spliterator

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

Constructor Summary

Constructors

Modifier	Constructor	Description
(package private)	PrimitiveSpliterator()	Creates a new iterator for the whole content of the backing list.
private	PrimitiveSpliterator(IntegerList.PrimitiveSpliterator suffix, int startAt)	Creates the prefix spliterator in a call to trySplit().

Method Summary

Modifier and Type	Method	Description
int	characteristics()	Declares that this split iterator does not return null elements, that all elements are traversed in a fixed order (which is increasing index values) and that IntegerList.size() represents an exact count of elements.
long	estimateSize()	Returns the exact number of values to be encountered by a forEachRemaining(…) traversal.
void	forEachRemaining(Consumer<? super Integer> action)	Performs the given action on all remaining elements.
void	forEachRemaining(IntConsumer action)	Performs the given action on all remaining elements.
boolean	hasNext()	Returns true if there is one more value to return.
int	nextInt()	Returns the next integer values in iterator order.
void	remove()	Removes the last element returned by nextInt().
boolean	tryAdvance(IntConsumer action)	If a remaining element exists, performs the given action on it and returns true.
Spliterator.OfInt	trySplit()

Methods inherited from class Object

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

Methods inherited from interface PrimitiveIterator.OfInt

next

Methods inherited from interface Spliterator

getComparator, getExactSizeIfKnown, hasCharacteristics

Methods inherited from interface Spliterator.OfInt

tryAdvance

Field Details

stopAt

private int stopAt

Index after the last element returned by this spliterator. This is initially IntegerList.size, but may be set to a smaller value by call to trySplit().

nextIndex

private int nextIndex

Index of the next element to be returned.

expectedModCount

private int expectedModCount

The AbstractList.modCount value as iterator construction time. Used for detecting modification in the backing list during traversal.

lastRemove

private int lastRemove

Index of the last elements removed by a remove() operation. This is used for checking that remove() is not invoked twice before the next advance.

Constructor Details

PrimitiveSpliterator

PrimitiveSpliterator()

Creates a new iterator for the whole content of the backing list.

PrimitiveSpliterator

private PrimitiveSpliterator(IntegerList.PrimitiveSpliterator suffix,
 int startAt)

Creates the prefix spliterator in a call to trySplit().

Parameters:

suffix - the spliterator which will continue iteration after this spliterator.

startAt - index of the first element to be returned by this prefix spliterator.

Method Details

characteristics

public int characteristics()

Declares that this split iterator does not return null elements, that all elements are traversed in a fixed order (which is increasing index values) and that IntegerList.size() represents an exact count of elements.

Specified by:

characteristics in interface Spliterator<Integer>

estimateSize

public long estimateSize()

Returns the exact number of values to be encountered by a forEachRemaining(…) traversal.

Specified by:

estimateSize in interface Spliterator<Integer>

trySplit

public Spliterator.OfInt trySplit()

Specified by:

trySplit in interface Spliterator<Integer>

Specified by:

trySplit in interface Spliterator.OfInt

Specified by:

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

hasNext

public boolean hasNext()

Returns true if there is one more value to return. This method also ensures that no alteration has happened on the backing list since the spliterator creation.

Specified by:

hasNext in interface Iterator<Integer>

nextInt

public int nextInt()

Returns the next integer values in iterator order.

Specified by:

nextInt in interface PrimitiveIterator.OfInt

tryAdvance

public boolean tryAdvance(IntConsumer action)

If a remaining element exists, performs the given action on it and returns true. Otherwise returns false.

Specified by:

tryAdvance in interface Spliterator.OfInt

Specified by:

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

forEachRemaining

public void forEachRemaining(IntConsumer action)

Performs the given action on all remaining elements. This implementation is shared by both Iterator and Spliterator interfaces.

Specified by:

forEachRemaining in interface PrimitiveIterator<Integer, IntConsumer>

Specified by:

forEachRemaining in interface PrimitiveIterator.OfInt

Specified by:

forEachRemaining in interface Spliterator.OfInt

Specified by:

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

forEachRemaining

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

Performs the given action on all remaining elements. This implementation is shared by both Iterator and Spliterator interfaces.

Specified by:

forEachRemaining in interface Iterator<Integer>

Specified by:

forEachRemaining in interface PrimitiveIterator.OfInt

Specified by:

forEachRemaining in interface Spliterator<Integer>

Specified by:

forEachRemaining in interface Spliterator.OfInt

remove

public void remove()

Removes the last element returned by nextInt().

Specified by:

remove in interface Iterator<Integer>