it.unimi.dsi.fastutil.booleans

Class BooleanIterators.AbstractIndexBasedListIterator

java.lang.Object

it.unimi.dsi.fastutil.booleans.AbstractBooleanIterator

it.unimi.dsi.fastutil.booleans.BooleanIterators.AbstractIndexBasedIterator

it.unimi.dsi.fastutil.booleans.BooleanIterators.AbstractIndexBasedListIterator

All Implemented Interfaces:

it.unimi.dsi.fastutil.BidirectionalIterator<java.lang.Boolean>, BooleanBidirectionalIterator, it.unimi.dsi.fastutil.booleans.BooleanIterator, BooleanListIterator, it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator<java.lang.Boolean>, it.unimi.dsi.fastutil.objects.ObjectIterator<java.lang.Boolean>, java.util.Iterator<java.lang.Boolean>, java.util.ListIterator<java.lang.Boolean>, java.util.PrimitiveIterator<java.lang.Boolean,it.unimi.dsi.fastutil.booleans.BooleanConsumer>

Enclosing class:

BooleanIterators

public abstract static class BooleanIterators.AbstractIndexBasedListIterator
extends BooleanIterators.AbstractIndexBasedIterator
implements BooleanListIterator

A skeletal implementation for a list-iterator backed by an index-based data store. High performance concrete implementations (like the main ListIterator of ArrayList) generally should avoid using this and just implement the interface directly, but should be decent for less performance critical implementations.

This class is only appropriate for sequences that are at most Integer.MAX_VALUE long. If your backing data store can be bigger then this, consider the equivalently named class in the type specific BigListSpliterators class.

As the abstract methods in this class are used in inner loops, it is generally a good idea to override the class as final as to encourage the JVM to inline them (or alternatively, override the abstract methods as final).

Nested Class Summary

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

java.util.PrimitiveIterator.OfDouble, java.util.PrimitiveIterator.OfInt, java.util.PrimitiveIterator.OfLong

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.booleans.BooleanIterators.AbstractIndexBasedIterator

lastReturned, minPos, pos

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIndexBasedListIterator(int minPos, int initialPos)

Method Summary

Modifier and Type	Method and Description
void	add(boolean k) Inserts the specified element into the list (optional operation).
protected abstract void	add(int location, boolean k) Add the given item at the given index.
int	back(int n) Moves back for the given number of elements.
boolean	hasPrevious()
int	nextIndex()
boolean	previousBoolean() Returns the previous element as a primitive type.
int	previousIndex()
void	set(boolean k) Replaces the last element returned by BooleanListIterator.next() or BooleanListIterator.previous() with the specified element (optional operation).
protected abstract void	set(int location, boolean k) Sets the given item at the given index.

Methods inherited from class it.unimi.dsi.fastutil.booleans.BooleanIterators.AbstractIndexBasedIterator

forEachRemaining, get, getMaxPos, hasNext, nextBoolean, remove, remove, skip

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanListIterator

add, next, previous, remove, set

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanBidirectionalIterator

skip

Methods inherited from interface it.unimi.dsi.fastutil.booleans.BooleanIterator

forEachRemaining, forEachRemaining, nextBoolean

Methods inherited from interface java.util.Iterator

hasNext

Methods inherited from interface java.util.ListIterator

hasNext

Constructor Detail

AbstractIndexBasedListIterator

protected AbstractIndexBasedListIterator(int minPos,
                                         int initialPos)

Method Detail

add

protected abstract void add(int location,
                            boolean k)

Add the given item at the given index.

This method should also do what is needed to track the change to the BooleanIterators.AbstractIndexBasedIterator.getMaxPos(). Usually this is accomplished by having this method call the parent Collection's appropriate add method, and having BooleanIterators.AbstractIndexBasedIterator.getMaxPos() track the parent collection's size.

Do not modify BooleanIterators.AbstractIndexBasedIterator.pos in this method; the default #add() method takes care of this.

See BooleanIterators.AbstractIndexBasedIterator.pos and BooleanIterators.AbstractIndexBasedIterator.get(int) for discussion on what the location means.

set

protected abstract void set(int location,
                            boolean k)

Sets the given item at the given index.

See BooleanIterators.AbstractIndexBasedIterator.pos and BooleanIterators.AbstractIndexBasedIterator.get(int) for discussion on what the location means.

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface it.unimi.dsi.fastutil.BidirectionalIterator<java.lang.Boolean>

Specified by:

hasPrevious in interface java.util.ListIterator<java.lang.Boolean>

previousBoolean

public boolean previousBoolean()

Description copied from interface: BooleanBidirectionalIterator

Returns the previous element as a primitive type.

Specified by:

previousBoolean in interface BooleanBidirectionalIterator

Returns:

the previous element in the iteration.

See Also:

ListIterator.previous()

nextIndex

public int nextIndex()

Specified by:

nextIndex in interface java.util.ListIterator<java.lang.Boolean>

previousIndex

public int previousIndex()

Specified by:

previousIndex in interface java.util.ListIterator<java.lang.Boolean>

add

public void add(boolean k)

Description copied from interface: BooleanListIterator

Inserts the specified element into the list (optional operation).

This default implementation just throws an UnsupportedOperationException.

Specified by:

add in interface BooleanListIterator

Parameters:

k - the element to insert.

See Also:

ListIterator.add(Object)

set

public void set(boolean k)

Description copied from interface: BooleanListIterator

Replaces the last element returned by BooleanListIterator.next() or BooleanListIterator.previous() with the specified element (optional operation).

Specified by:

set in interface BooleanListIterator

Parameters:

k - the element used to replace the last element returned.

This default implementation just throws an UnsupportedOperationException.

See Also:

ListIterator.set(Object)

back

public int back(int n)

Description copied from interface: BooleanBidirectionalIterator

Moves back for the given number of elements.

The effect of this call is exactly the same as that of calling BooleanBidirectionalIterator.previous() for n times (possibly stopping if BidirectionalIterator.hasPrevious() becomes false).

Specified by:

back in interface BooleanBidirectionalIterator

Specified by:

back in interface it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator<java.lang.Boolean>

Parameters:

n - the number of elements to skip back.

Returns:

the number of elements actually skipped.

See Also:

BooleanBidirectionalIterator.previous()