Class ResultSetIterator

java.lang.Object
org.apache.commons.dbutils.ResultSetIterator
All Implemented Interfaces:
Iterator<Object[]>
public class ResultSetIterator extends Object implements Iterator<Object[]>

Wraps a ResultSet in an Iterator&lt;Object[]&gt;. This is useful when you want to present a non-database application layer with domain neutral data.

This implementation requires the ResultSet.isLast() method to be implemented.

  • Field Details

    • rs

      private final ResultSet rs
      The wrapped ResultSet.

    • convert

      private final RowProcessor convert
      The processor to use when converting a row into an Object[].

  • Constructor Details

    • ResultSetIterator

      public ResultSetIterator(ResultSet rs)
      Constructor for ResultSetIterator.
      Parameters:
      rs - Wrap this ResultSet in an Iterator.

    • ResultSetIterator

      public ResultSetIterator(ResultSet rs, RowProcessor convert)
      Constructor for ResultSetIterator.
      Parameters:
      rs - Wrap this ResultSet in an Iterator.
      convert - The processor to use when converting a row into an Object[]. Defaults to a BasicRowProcessor.

  • Method Details

    • hasNext

      public boolean hasNext()
      Returns true if there are more rows in the ResultSet.
      Specified by:
      hasNext in interface Iterator<Object[]>
      Returns:
      boolean true if there are more rows
      Throws:
      RuntimeException - if an SQLException occurs.

    • next

      public Object[] next()
      Returns the next row as an Object[].
      Specified by:
      next in interface Iterator<Object[]>
      Returns:
      An Object[] with the same number of elements as columns in the ResultSet.
      Throws:
      RuntimeException - if an SQLException occurs.
      See Also:

    • remove

      public void remove()
      Deletes the current row from the ResultSet.
      Specified by:
      remove in interface Iterator<Object[]>
      Throws:
      RuntimeException - if an SQLException occurs.
      See Also:

    • rethrow

      protected void rethrow(SQLException e)
      Rethrow the SQLException as a RuntimeException. This implementation creates a new RuntimeException with the SQLException's error message.
      Parameters:
      e - SQLException to rethrow
      Since:
      DbUtils 1.1

    • iterable

      public static Iterable<Object[]> iterable(ResultSet rs)
      Generates an Iterable, suitable for use in for-each loops.
      Parameters:
      rs - Wrap this ResultSet in an Iterator.
      Returns:
      an Iterable, suitable for use in for-each loops.