Package com.github.tommyettinger.ds

Class CharDeque.CharDequeIterator

java.lang.Object
com.github.tommyettinger.ds.CharList.CharListIterator
com.github.tommyettinger.ds.CharDeque.CharDequeIterator
All Implemented Interfaces:
CharIterator, Iterator<Character>
Enclosing class:
CharDeque
public static class CharDeque.CharDequeIterator extends CharList.CharListIterator implements CharIterator
A CharIterator over the elements of a CharDeque.

  • Field Details

    • index

      protected int index

    • latest

      protected int latest

    • valid

      protected boolean valid

    • direction

      protected final int direction

  • Constructor Details

    • CharDequeIterator

      public CharDequeIterator(CharDeque deque)

    • CharDequeIterator

      public CharDequeIterator(CharDeque deque, boolean descendingOrder)

    • CharDequeIterator

      public CharDequeIterator(CharDeque deque, int index, boolean descendingOrder)

  • Method Details

    • nextChar

      public char nextChar()
      Returns the next char element in the iteration.
      Specified by:
      nextChar in interface CharIterator
      Overrides:
      nextChar in class CharList.CharListIterator
      Returns:
      the next char 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 CharIterator.next() would return an element rather than throwing an exception.)
      Specified by:
      hasNext in interface Iterator<Character>
      Overrides:
      hasNext in class CharList.CharListIterator
      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.)
      Overrides:
      hasPrevious in class CharList.CharListIterator
      Returns:
      true if the list iterator has more elements when traversing the list in the reverse direction

    • previous

      public char 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 CharIterator.next() to go back and forth. (Note that alternating calls to next and previous will return the same element repeatedly.)
      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 CharIterator.next(). (Returns list size if the list iterator is at the end of the list.)
      Overrides:
      nextIndex in class CharList.CharListIterator
      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.)
      Overrides:
      previousIndex in class CharList.CharListIterator
      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 CharIterator.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(char) has not been called after the last call to next or previous.
      Specified by:
      remove in interface Iterator<Character>
      Overrides:
      remove in class CharList.CharListIterator
      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(char t)
      Replaces the last element returned by CharIterator.next() or previous() with the specified element (optional operation). This call can be made only if neither remove() nor add(char) have been called after the last call to next or previous.
      Overrides:
      set in class CharList.CharListIterator
      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(char t)
      Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by CharIterator.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.)
      Overrides:
      add in class CharList.CharListIterator
      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()
      Overrides:
      reset in class CharList.CharListIterator

    • reset

      public void reset(int index)
      Overrides:
      reset in class CharList.CharListIterator

    • iterator

      public CharDeque.CharDequeIterator iterator()
      Returns an iterator over elements of type char.
      Overrides:
      iterator in class CharList.CharListIterator
      Returns:
      a CharIterator; really this same CharDequeIterator.