Package dev.morphia.query.internal

Class MorphiaKeyCursor<T>

  • Type Parameters:
    T - the entity type
    All Implemented Interfaces:
    com.mongodb.client.MongoCursor<Key<T>>, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<Key<T>>
    public class MorphiaKeyCursor<T>
extends java.lang.Object
implements com.mongodb.client.MongoCursor<Key<T>>
    Defines an Iterator across the Key values for a given type.

    • Constructor Summary

      Constructors 
      Constructor Description
      MorphiaKeyCursor​(Datastore datastore, com.mongodb.Cursor cursor, Mapper mapper, java.lang.Class<T> clazz, java.lang.String collection)
      Create

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Closes the underlying cursor.
      com.mongodb.ServerAddress getServerAddress()  
      com.mongodb.ServerCursor getServerCursor()  
      boolean hasNext()  
      Key<T> next()  
      void remove()  
      java.util.List<Key<T>> toList()
      Converts this cursor to a List.
      Key<T> tryNext()  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.util.Iterator

        forEachRemaining

    • Constructor Detail

      • MorphiaKeyCursor

        public MorphiaKeyCursor​(Datastore datastore,
                        com.mongodb.Cursor cursor,
                        Mapper mapper,
                        java.lang.Class<T> clazz,
                        java.lang.String collection)
        Create
        Parameters:
        datastore - the Datastore to use when fetching this reference
        cursor - the cursor to use
        mapper - the Mapper to use
        clazz - the original type being iterated
        collection - the mongodb collection

    • Method Detail

      • close

        public void close()
        Closes the underlying cursor.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface com.mongodb.client.MongoCursor<T>

      • hasNext

        public boolean hasNext()
        Specified by:
        hasNext in interface java.util.Iterator<T>
        Specified by:
        hasNext in interface com.mongodb.client.MongoCursor<T>

      • next

        public Key<T> next()
        Specified by:
        next in interface java.util.Iterator<T>
        Specified by:
        next in interface com.mongodb.client.MongoCursor<T>

      • tryNext

        public Key<T> tryNext()
        Specified by:
        tryNext in interface com.mongodb.client.MongoCursor<T>

      • toList

        public java.util.List<Key<T>> toList()
        Converts this cursor to a List. Care should be taken on large datasets as OutOfMemoryErrors are a risk.
        Returns:
        the list of Entities

      • getServerCursor

        public com.mongodb.ServerCursor getServerCursor()
        Specified by:
        getServerCursor in interface com.mongodb.client.MongoCursor<T>

      • getServerAddress

        public com.mongodb.ServerAddress getServerAddress()
        Specified by:
        getServerAddress in interface com.mongodb.client.MongoCursor<T>

      • remove

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