Package com.github.tommyettinger.ds

Class CharList.CharListIterator

java.lang.Object
com.github.tommyettinger.ds.CharList.CharListIterator
All Implemented Interfaces:
CharIterator, Iterator<Character>
Direct Known Subclasses:
CharDeque.CharDequeIterator
Enclosing class:
CharList
public static class CharList.CharListIterator extends Object implements CharIterator
A CharIterator, plus ListIterator methods, over the elements of a CharList. Use nextChar() in preference to CharIterator.next() to avoid allocating Character objects.

  • Field Details

    • index

      protected int index

    • latest

      protected int latest

    • list

      protected CharList list

    • valid

      public boolean valid
      Used to track if a reusable iterator can be used now. This is public so subclasses of CharList (in other packages) can still access this directly even though it belongs to CharListIterator, not CharList.

  • Constructor Details

    • CharListIterator

      public CharListIterator(CharList list)

    • CharListIterator

      public CharListIterator(CharList list, int index)

  • Method Details

    • nextChar

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

    • previousChar

      public char previousChar()
      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 nextChar() 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 nextChar(). (Returns list size if the list iterator is at the end of the list.)
      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 previousChar(). (Returns -1 if the list iterator is at the beginning of the list.)
      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 nextChar() or previousChar() (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>
      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 nextChar() or previousChar() 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.
      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 nextChar(), if any, and after the element that would be returned by previousChar(), 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.)
      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 CharList.CharListIterator iterator()
      Returns an iterator over elements of type char.
      Returns:
      this same CharListIterator.