Package org.hibernate.internal

Class EmptyScrollableResults<R>

java.lang.Object
org.hibernate.internal.EmptyScrollableResults<R>
All Implemented Interfaces:
AutoCloseable, ScrollableResultsImplementor<R>, ScrollableResults<R>
public class EmptyScrollableResults<R> extends Object implements ScrollableResultsImplementor<R>

  • Constructor Summary

    Constructors
    Constructor
    Description
    EmptyScrollableResults()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    afterLast()
    Go to a location just after the last result.
    void
    beforeFirst()
    Go to a location just before first result.
    void
    close()
    Release resources immediately.
    boolean
    first()
    Go to the first result.
    R
    get()
    Get the current row of results.
    int
    getPosition()
    The current position within the query results.
    int
    getRowNumber()
    Get the current position in the results, with the first position labelled as row number 0.
    static <R> EmptyScrollableResults<R>
    instance()
     
    boolean
    isClosed()
     
    boolean
    isFirst()
    Is this the first result?
    boolean
    isLast()
    Is this the last result?
    boolean
    last()
    Go to the last result.
    boolean
    next()
    Advance to the next result.
    boolean
    position(int position)
    Moves the result cursor to the specified position.
    boolean
    previous()
    Retreat to the previous result.
    boolean
    scroll(int positions)
    Scroll the specified number of positions from the current position.
    void
    setFetchSize(int fetchSize)
    Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
    boolean
    setRowNumber(int rowNumber)
    Set the current position in the result set, with the first position labelled as row number 1, and the last position labelled as row number -1.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EmptyScrollableResults

      public EmptyScrollableResults()

  • Method Details

    • instance

      public static <R> EmptyScrollableResults<R> instance()

    • isClosed

      public boolean isClosed()
      Specified by:
      isClosed in interface ScrollableResults<R>
      Returns:
      true if ScrollableResults.close() was already called

    • close

      public void close()
      Description copied from interface: ScrollableResults
      Release resources immediately.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface ScrollableResults<R>

    • next

      public boolean next()
      Description copied from interface: ScrollableResults
      Advance to the next result.
      Specified by:
      next in interface ScrollableResults<R>
      Returns:
      true if there is another result

    • previous

      public boolean previous()
      Description copied from interface: ScrollableResults
      Retreat to the previous result.
      Specified by:
      previous in interface ScrollableResults<R>
      Returns:
      true if there is a previous result

    • scroll

      public boolean scroll(int positions)
      Description copied from interface: ScrollableResults
      Scroll the specified number of positions from the current position.
      Specified by:
      scroll in interface ScrollableResults<R>
      Parameters:
      positions - a positive (forward) or negative (backward) number of positions
      Returns:
      true if there is a result at the new location

    • position

      public boolean position(int position)
      Description copied from interface: ScrollableResults
      Moves the result cursor to the specified position. The index may be a positive value, and the position may be reached by counting forward from the first result at position 1, or it may be a negative value, so that the position may be reached by counting backward from the last result at position -1.
      Specified by:
      position in interface ScrollableResults<R>
      Parameters:
      position - an absolute positive (from the start) or negative (from the end) position within the query results
      Returns:
      true if there is a result at the new location

    • last

      public boolean last()
      Description copied from interface: ScrollableResults
      Go to the last result.
      Specified by:
      last in interface ScrollableResults<R>
      Returns:
      true if there are any results

    • first

      public boolean first()
      Description copied from interface: ScrollableResults
      Go to the first result.
      Specified by:
      first in interface ScrollableResults<R>
      Returns:
      true if there are any results

    • beforeFirst

      public void beforeFirst()
      Description copied from interface: ScrollableResults
      Go to a location just before first result.

      This is the location of the cursor on a newly returned scrollable result.

      Specified by:
      beforeFirst in interface ScrollableResults<R>

    • afterLast

      public void afterLast()
      Description copied from interface: ScrollableResults
      Go to a location just after the last result.
      Specified by:
      afterLast in interface ScrollableResults<R>

    • isFirst

      public boolean isFirst()
      Description copied from interface: ScrollableResults
      Is this the first result?
      Specified by:
      isFirst in interface ScrollableResults<R>
      Returns:
      true if this is the first row of results, otherwise false

    • isLast

      public boolean isLast()
      Description copied from interface: ScrollableResults
      Is this the last result?
      Specified by:
      isLast in interface ScrollableResults<R>
      Returns:
      true if this is the last row of results.

    • getRowNumber

      public int getRowNumber()
      Description copied from interface: ScrollableResults
      Get the current position in the results, with the first position labelled as row number 0. That is, this operation returns position-1.
      Specified by:
      getRowNumber in interface ScrollableResults<R>
      Returns:
      The current position number, numbered from 0; -1 indicates that there is no current row

    • getPosition

      public int getPosition()
      Description copied from interface: ScrollableResults
      The current position within the query results. The first query result, if any, is at position 1. An empty or newly-created instance has position 0.
      Specified by:
      getPosition in interface ScrollableResults<R>
      Returns:
      the current position, a positive integer index starting at 1, or 0 if this instance is empty or newly-created

    • setRowNumber

      public boolean setRowNumber(int rowNumber)
      Description copied from interface: ScrollableResults
      Set the current position in the result set, with the first position labelled as row number 1, and the last position labelled as row number -1. Results may be numbered from the first result (using a positive position) or backward from the last result (using a negative position).
      Specified by:
      setRowNumber in interface ScrollableResults<R>
      Parameters:
      rowNumber - the row number. A positive number indicates a value numbered from the first row; a negative number indicates a value numbered from the last row.
      Returns:
      true if there is a row at that row number

    • setFetchSize

      public void setFetchSize(int fetchSize)
      Description copied from interface: ScrollableResults
      Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If 0, the JDBC driver's default setting will be used.
      Specified by:
      setFetchSize in interface ScrollableResults<R>
      See Also:

    • get

      public R get()
      Description copied from interface: ScrollableResults
      Get the current row of results.
      Specified by:
      get in interface ScrollableResults<R>
      Returns:
      The array of results