Package org.springframework.data.redis.core

Class ScanCursor<T>

java.lang.Object
org.springframework.data.redis.core.ScanCursor<T>
Type Parameters:
T -
All Implemented Interfaces:
Closeable, AutoCloseable, Iterator<T>, Cursor<T>, CloseableIterator<T>
Direct Known Subclasses:
KeyBoundCursor
public abstract class ScanCursor<T> extends Object implements Cursor<T>
Redis client agnostic Cursor implementation continuously loading additional results from Redis server until reaching its starting point zero.
Note: Please note that the ScanCursor has to be initialized (open() prior to usage. Any failures during scanning will close the cursor and release any associated resources such as connections.
Since:
1.4
Author:
Christoph Strobl, Thomas Darimont, Duobiao Ou, Marl Paluch

  • Constructor Details

  • Method Details

    • doScan

      @Deprecated(since="3.3.0") protected ScanIteration<T> doScan(long cursorId, ScanOptions options)
      Deprecated.
      since 3.3.0, cursorId, can exceed Long.MAX_VALUE.
      Performs the actual scan command using the native client implementation. The given options are never null.
      Parameters:
      cursorId -
      options -
      Returns:

    • doScan

      protected ScanIteration<T> doScan(Cursor.CursorId cursorId, ScanOptions options)
      Performs the actual scan command using the native client implementation. The given options are never null.
      Parameters:
      cursorId -
      options -
      Returns:
      Since:
      3.3.0

    • open

      public final ScanCursor<T> open()
      Initialize the Cursor prior to usage.

    • doOpen

      @Deprecated(since="3.3.0", forRemoval=true) protected void doOpen(long cursorId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 3.3.0, use doOpen(CursorId) instead.
      Customization hook when calling open().
      Parameters:
      cursorId -

    • doOpen

      protected void doOpen(Cursor.CursorId cursorId)
      Customization hook when calling open().
      Parameters:
      cursorId -

    • isFinished

      @Deprecated(since="3.3.0", forRemoval=true) protected boolean isFinished(long cursorId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether cursorId is finished.
      Parameters:
      cursorId - the cursor Id
      Returns:
      true if the cursor is considered finished, false otherwise.s
      Since:
      2.1

    • isFinished

      protected boolean isFinished(Cursor.CursorId cursorId)
      Check whether cursorId is finished.
      Parameters:
      cursorId - the cursor Id
      Returns:
      true if the cursor is considered finished, false otherwise.s
      Since:
      3.3.0

    • getId

      public Cursor.CursorId getId()
      Description copied from interface: Cursor
      Returns the reference cursor.
      Specified by:
      getId in interface Cursor<T>
      Returns:
      the reference cursor.

    • getCursorId

      public long getCursorId()
      Description copied from interface: Cursor
      Get the reference cursor.
      NOTE: the id might change while iterating items.
      Specified by:
      getCursorId in interface Cursor<T>
      Returns:

    • hasNext

      public boolean hasNext()
      Specified by:
      hasNext in interface Iterator<T>

    • next

      public T next()
      Specified by:
      next in interface Iterator<T>

    • moveNext

      protected T moveNext(Iterator<T> source)
      Fetch the next item from the underlying Iterable.
      Parameters:
      source -
      Returns:

    • remove

      public void remove()
      Specified by:
      remove in interface Iterator<T>

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface CloseableIterator<T>

    • doClose

      protected void doClose()
      Customization hook for cleaning up resources on when calling close().

    • isClosed

      public boolean isClosed()
      Specified by:
      isClosed in interface Cursor<T>
      Returns:
      true if cursor closed.

    • isReady

      protected final boolean isReady()

    • isOpen

      protected final boolean isOpen()

    • getPosition

      public long getPosition()
      Specified by:
      getPosition in interface Cursor<T>
      Returns:
      the current position of the cursor.