Interface IntListIterator

All Known Subinterfaces:
ComparableIntIterator

public interface IntListIterator
Int iterator in the Java style, but returning/using ints. Contrast with IntPointerIterator, which is in the UIMA style allowing forward and backwards movement.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Check if there is a next element.
    boolean
    Check if there is a previous element.
    void
    Move the iterator to the end of the underlying index.
    void
    Move the iterator to the start of the underlying index.
    int
    Return the next feature structure and increment the iterator.
    int
    Return the previous feature structure and decrement the iterator.
  • Method Details

    • hasNext

      boolean hasNext()
      Check if there is a next element. Does not move the iterator.
      Returns:
      true iff there is a next element.
    • next

      int next() throws NoSuchElementException
      Return the next feature structure and increment the iterator.
      Returns:
      The next feature structure.
      Throws:
      NoSuchElementException - If no next element exists, i.e., when the iterator points at the last position in the index.
    • hasPrevious

      boolean hasPrevious()
      Check if there is a previous element. Does not move the iterator.
      Returns:
      true iff there is a previous element.
    • previous

      int previous()
      Return the previous feature structure and decrement the iterator.
      Returns:
      The previous feature structure.
      Throws:
      NoSuchElementException - If no previous element exists, i.e., when the iterator points at the first position in the index.
    • moveToStart

      void moveToStart()
      Move the iterator to the start of the underlying index.
    • moveToEnd

      void moveToEnd()
      Move the iterator to the end of the underlying index.