Package com.github.tommyettinger.ds

Class ObjectDeque.ObjectDequeIterator<T>

java.lang.Object
com.github.tommyettinger.ds.ObjectDeque.ObjectDequeIterator<T>
Type Parameters:
T - the generic type for the ObjectDeque this iterates over
All Implemented Interfaces:
Iterable<T>, Iterator<T>, ListIterator<T>
Enclosing class:
ObjectDeque<T>
public static class ObjectDeque.ObjectDequeIterator<T> extends Object implements Iterable<T>, ListIterator<T>
An Iterator and ListIterator over the elements of an ObjectDeque, while also an Iterable.

  • Field Details

    • index

      public int index

    • latest

      public int latest

    • deque

      public ObjectDeque<T> deque

    • valid

      public boolean valid

    • direction

      public final int direction

    • expectedModCount

      public int expectedModCount

  • Constructor Details

    • ObjectDequeIterator

      public ObjectDequeIterator(ObjectDeque<T> deque)

    • ObjectDequeIterator

      public ObjectDequeIterator(ObjectDeque<T> deque, boolean descendingOrder)

    • ObjectDequeIterator

      public ObjectDequeIterator(ObjectDeque<T> deque, int index, boolean descendingOrder)

  • Method Details

    • modCheck

      public final void modCheck()
      Checks if this iterator's expected amount of modifications to the deque matches what the deque reports. This is used to ensure the ObjectDeque.iterator() and ObjectDeque.listIterator() are both fail-fast iterators.
      Throws:
      ConcurrentModificationException - if the check fails

    • next

      public T next()
      Returns the next T element in the iteration.
      Specified by:
      next in interface Iterator<T>
      Specified by:
      next in interface ListIterator<T>
      Returns:
      the next T element in the iteration
      Throws:
      NoSuchElementException - if the iteration has no more elements

    • hasNext

      public boolean hasNext()
      Returns true if the iteration has more elements. (In other words, returns true if next() would return an element rather than throwing an exception.)
      Specified by:
      hasNext in interface Iterator<T>
      Specified by:
      hasNext in interface ListIterator<T>
      Returns:
      true if the iteration has more elements

    • hasPrevious

      public boolean hasPrevious()
      Returns true if this list iterator has more elements when traversing the list in the reverse direction. (In other words, returns true if previous() would return an element rather than throwing an exception.)
      Specified by:
      hasPrevious in interface ListIterator<T>
      Returns:
      true if the list iterator has more elements when traversing the list in the reverse direction

    • previous

      public T previous()
      Returns the previous element in the list and moves the cursor position backwards. This method may be called repeatedly to iterate through the list backwards, or intermixed with calls to next() to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)
      Specified by:
      previous in interface ListIterator<T>
      Returns:
      the previous element in the list
      Throws:
      NoSuchElementException - if the iteration has no previous element

    • nextIndex

      public int nextIndex()
      Returns the index of the element that would be returned by a subsequent call to next(). (Returns list size if the list iterator is at the end of the list.)
      Specified by:
      nextIndex in interface ListIterator<T>
      Returns:
      the index of the element that would be returned by a subsequent call to next, or list size if the list iterator is at the end of the list

    • previousIndex

      public int previousIndex()
      Returns the index of the element that would be returned by a subsequent call to previous(). (Returns -1 if the list iterator is at the beginning of the list.)
      Specified by:
      previousIndex in interface ListIterator<T>
      Returns:
      the index of the element that would be returned by a subsequent call to previous, or -1 if the list iterator is at the beginning of the list

    • remove

      public void remove()
      Removes from the list the last element that was returned by next() or previous() (optional operation). This call can only be made once per call to next or previous. It can be made only if add(T) has not been called after the last call to next or previous.
      Specified by:
      remove in interface Iterator<T>
      Specified by:
      remove in interface ListIterator<T>
      Throws:
      UnsupportedOperationException - if the remove operation is not supported by this list iterator
      IllegalStateException - if neither next nor previous have been called, or remove or add have been called after the last call to next or previous

    • set

      public void set(T t)
      Replaces the last element returned by next() or previous() with the specified element (optional operation). This call can be made only if neither remove() nor add(T) have been called after the last call to next or previous.
      Specified by:
      set in interface ListIterator<T>
      Parameters:
      t - the element with which to replace the last element returned by next or previous
      Throws:
      UnsupportedOperationException - if the set operation is not supported by this list iterator
      ClassCastException - if the class of the specified element prevents it from being added to this list
      IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list
      IllegalStateException - if neither next nor previous have been called, or remove or add have been called after the last call to next or previous

    • add

      public void add(T t)
      Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by next(), if any, and after the element that would be returned by previous(), if any. (If the list contains no elements, the new element becomes the sole element on the list.) The new element is inserted before the implicit cursor: a subsequent call to next would be unaffected, and a subsequent call to previous would return the new element. (This call increases by one the value that would be returned by a call to nextIndex or previousIndex.)
      Specified by:
      add in interface ListIterator<T>
      Parameters:
      t - the element to insert
      Throws:
      UnsupportedOperationException - if the add method is not supported by this list iterator
      ClassCastException - if the class of the specified element prevents it from being added to this list
      IllegalArgumentException - if some aspect of this element prevents it from being added to this list

    • reset

      public void reset()

    • reset

      public void reset(int index)

    • iterator

      public ObjectDeque.ObjectDequeIterator<T> iterator()
      Returns an iterator over elements of type T.
      Specified by:
      iterator in interface Iterable<T>
      Returns:
      a ListIterator; really this same ObjectDequeIterator.