Class ObjectIterators.AbstractIndexBasedIterator<K>

java.lang.Object
it.unimi.dsi.fastutil.objects.AbstractObjectIterator<K>
it.unimi.dsi.fastutil.objects.ObjectIterators.AbstractIndexBasedIterator<K>
All Implemented Interfaces:
it.unimi.dsi.fastutil.objects.ObjectIterator<K>, Iterator<K>
Direct Known Subclasses:
ObjectIterators.AbstractIndexBasedListIterator
Enclosing class:
ObjectIterators

public abstract static class ObjectIterators.AbstractIndexBasedIterator<K> extends AbstractObjectIterator<K>
A skeletal implementation for an iterator backed by an index-based data store. High performance concrete implementations (like the main Iterator 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 BigListIterators 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
    Modifier and Type
    Field
    Description
    protected int
    The last returned index by a call to next() or, if a list-iterator,
    invalid @link
    {@link java.util.ListIterator#previous().
    It is −1 if no such call has occurred or a mutation has occurred through this iterator and no advancement has been done.
    protected final int
    The minimum pos can be, and is the logical start of the "range".
    protected int
    The current position index, the index of the item to be returned after the next call to next().
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractIndexBasedIterator(int minPos, int initialPos)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    forEachRemaining(Consumer<? super K> action)
     
    protected abstract K
    get(int location)
    Get the item corresponding to the given index location.
    protected abstract int
    The maximum pos can be, and is the logical end (exclusive) of the "range".
    boolean
     
     
    void
     
    protected abstract void
    remove(int location)
    Remove the item at the given index.
    int
    skip(int n)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • minPos

      protected final int minPos
      The minimum pos can be, and is the logical start of the "range". Usually set to the initialPos unless it is a ListIterator, in which case it can vary. There isn't any way for a range to shift its beginning like the end can (through remove(int)), so this is final.
    • pos

      protected int pos
      The current position index, the index of the item to be returned after the next call to next().

      This value will be between minPos and getMaxPos() (exclusive) (on a best effort, so concurrent structural modifications outside this iterator may cause this to be violated, but that usually invalidates iterators anyways). Thus pos being minPos + 2 would mean next() was called twice and the next call will return the third element of this iterator.

    • lastReturned

      protected int lastReturned
      The last returned index by a call to next() or, if a list-iterator,
      invalid @link
      {@link java.util.ListIterator#previous().
      It is −1 if no such call has occurred or a mutation has occurred through this iterator and no advancement has been done.
  • Constructor Details

    • AbstractIndexBasedIterator

      protected AbstractIndexBasedIterator(int minPos, int initialPos)
  • Method Details

    • get

      protected abstract K get(int location)
      Get the item corresponding to the given index location.

      Do not advance pos in this method; the default next method takes care of this.

      The location given will be between minPos and getMaxPos() (exclusive). Thus, a location of minPos + 2 would mean next() was called twice and this method should return what the next call to next() should return.

    • remove

      protected abstract void remove(int location)
      Remove the item at the given index.

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

      This method should also do what is needed to track the change to the getMaxPos(). Usually this is accomplished by having this method call the parent

      invalid reference
      Collection
      's appropriate remove method, and having getMaxPos() track the parent
      invalid reference
      collection's size
      .
    • getMaxPos

      protected abstract int getMaxPos()
      The maximum pos can be, and is the logical end (exclusive) of the "range".

      If pos is equal to the return of this method, this means the last element has been returned and the next call to next() will throw.

      Usually set return the parent

      invalid reference
      collection's size
      , but does not have to be (for example, sublists and subranges).
    • hasNext

      public boolean hasNext()
    • next

      public K next()
    • remove

      public void remove()
    • forEachRemaining

      public void forEachRemaining(Consumer<? super K> action)
    • skip

      public int skip(int n)