Package com.mongodb

Interface Cursor

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, java.util.Iterator<DBObject>
    All Known Implementing Classes:
    DBCursor
    public interface Cursor
extends java.util.Iterator<DBObject>, java.io.Closeable
    Interface for providing consistent behaviour between different Cursor implementations.
    Since:
    2.12

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Terminates this cursor on the server.
      long getCursorId()
      Gets the server's identifier for this Cursor.
      ServerAddress getServerAddress()
      Gets the address of the server that data is pulled from.

      • Methods inherited from interface java.util.Iterator

        forEachRemaining, hasNext, next, remove

    • Method Detail

      • getCursorId

        long getCursorId()
        Gets the server's identifier for this Cursor.
        Returns:
        the cursor's ID, or 0 if there is no active cursor.

      • getServerAddress

        ServerAddress getServerAddress()
        Gets the address of the server that data is pulled from. Note that this information may not be available until hasNext() or next() is called.
        Returns:
        the address of the server that data is pulled from

      • close

        void close()
        Terminates this cursor on the server.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable