Package com.github.tommyettinger.ds

Class BooleanDeque.BooleanDequeIterator

java.lang.Object
com.github.tommyettinger.ds.BooleanList.BooleanListIterator
com.github.tommyettinger.ds.BooleanDeque.BooleanDequeIterator
All Implemented Interfaces:
BooleanIterator, Iterator<Boolean>
Enclosing class:
BooleanDeque
public static class BooleanDeque.BooleanDequeIterator extends BooleanList.BooleanListIterator implements BooleanIterator
A BooleanIterator over the elements of a BooleanDeque.

  • Field Details

    • index

      protected int index

    • latest

      protected int latest

    • valid

      protected boolean valid

    • direction

      protected final int direction

  • Constructor Details

    • BooleanDequeIterator

      public BooleanDequeIterator(BooleanDeque deque)

    • BooleanDequeIterator

      public BooleanDequeIterator(BooleanDeque deque, boolean descendingOrder)

    • BooleanDequeIterator

      public BooleanDequeIterator(BooleanDeque deque, int index, boolean descendingOrder)

  • Method Details

    • nextBoolean

      public boolean nextBoolean()
      Returns the next boolean element in the iteration.
      Specified by:
      nextBoolean in interface BooleanIterator
      Overrides:
      nextBoolean in class BooleanList.BooleanListIterator
      Returns:
      the next boolean 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 BooleanIterator.next() would return an element rather than throwing an exception.)
      Specified by:
      hasNext in interface Iterator<Boolean>
      Overrides:
      hasNext in class BooleanList.BooleanListIterator
      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 BooleanList.BooleanListIterator
      Returns:
      true if the list iterator has more elements when traversing the list in the reverse direction

    • previous

      public boolean 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 BooleanIterator.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 BooleanIterator.next(). (Returns list size if the list iterator is at the end of the list.)
      Overrides:
      nextIndex in class BooleanList.BooleanListIterator
      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 BooleanList.BooleanListIterator
      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 BooleanIterator.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(boolean) has not been called after the last call to next or previous.
      Specified by:
      remove in interface Iterator<Boolean>
      Overrides:
      remove in class BooleanList.BooleanListIterator
      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(boolean t)
      Replaces the last element returned by BooleanIterator.next() or previous() with the specified element (optional operation). This call can be made only if neither remove() nor add(boolean) have been called after the last call to next or previous.
      Overrides:
      set in class BooleanList.BooleanListIterator
      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(boolean t)
      Inserts the specified element into the list (optional operation). The element is inserted immediately before the element that would be returned by BooleanIterator.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 BooleanList.BooleanListIterator
      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 BooleanList.BooleanListIterator

    • reset

      public void reset(int index)
      Overrides:
      reset in class BooleanList.BooleanListIterator

    • iterator

      public BooleanDeque.BooleanDequeIterator iterator()
      Returns an iterator over elements of type boolean.
      Overrides:
      iterator in class BooleanList.BooleanListIterator
      Returns:
      a BooleanIterator; really this same BooleanDequeIterator.