it.unimi.dsi.fastutil.objects

Class ObjectIterators.AbstractIndexBasedListIterator<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObjectIterator<K>

it.unimi.dsi.fastutil.objects.ObjectIterators.AbstractIndexBasedIterator<K>

it.unimi.dsi.fastutil.objects.ObjectIterators.AbstractIndexBasedListIterator<K>

All Implemented Interfaces:

it.unimi.dsi.fastutil.BidirectionalIterator<K>, it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator<K>, it.unimi.dsi.fastutil.objects.ObjectIterator<K>, ObjectListIterator<K>, java.util.Iterator<K>, java.util.ListIterator<K>

Enclosing class:

ObjectIterators

public abstract static class ObjectIterators.AbstractIndexBasedListIterator<K>
extends ObjectIterators.AbstractIndexBasedIterator<K>
implements ObjectListIterator<K>

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

Field Summary

Fields inherited from class it.unimi.dsi.fastutil.objects.ObjectIterators.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
protected abstract void	add(int location, K k) Add the given item at the given index.
void	add(K k) Inserts the specified element into the list (optional operation).
int	back(int n)
boolean	hasPrevious()
int	nextIndex()
K	previous()
int	previousIndex()
protected abstract void	set(int location, K k) Sets the given item at the given index.
void	set(K k) Replaces the last element returned by Iterator.next() or BidirectionalIterator.previous() with the specified element (optional operation).

Methods inherited from class it.unimi.dsi.fastutil.objects.ObjectIterators.AbstractIndexBasedIterator

forEachRemaining, get, getMaxPos, hasNext, next, 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.objects.ObjectListIterator

remove

Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator

skip

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next

Methods inherited from interface java.util.ListIterator

hasNext, next

Constructor Detail

AbstractIndexBasedListIterator

protected AbstractIndexBasedListIterator(int minPos,
                                         int initialPos)

Method Detail

add

protected abstract void add(int location,
                            K k)

Add the given item at the given index.

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

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

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

set

protected abstract void set(int location,
                            K k)

Sets the given item at the given index.

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

hasPrevious

public boolean hasPrevious()

Specified by:

hasPrevious in interface it.unimi.dsi.fastutil.BidirectionalIterator<K>

Specified by:

hasPrevious in interface java.util.ListIterator<K>

previous

public K previous()

Specified by:

previous in interface it.unimi.dsi.fastutil.BidirectionalIterator<K>

Specified by:

previous in interface java.util.ListIterator<K>

nextIndex

public int nextIndex()

Specified by:

nextIndex in interface java.util.ListIterator<K>

previousIndex

public int previousIndex()

Specified by:

previousIndex in interface java.util.ListIterator<K>

add

public void add(K k)

Description copied from interface: ObjectListIterator

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

This default implementation just throws an UnsupportedOperationException.

Specified by:

add in interface ObjectListIterator<K>

Specified by:

add in interface java.util.ListIterator<K>

Parameters:

k - the element to insert.

See Also:

ListIterator.add(Object)

set

public void set(K k)

Description copied from interface: ObjectListIterator

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

Specified by:

set in interface ObjectListIterator<K>

Specified by:

set in interface java.util.ListIterator<K>

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)

Specified by:

back in interface it.unimi.dsi.fastutil.objects.ObjectBidirectionalIterator<K>