Class RefCursor

    • Constructor Summary

      Constructors 
      Constructor Description
      RefCursor()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void close()
      abstract Ref getRef()
      Get reference at the current position.
      abstract boolean next()
      Check if another reference is available.
      abstract void seekPastPrefix​(java.lang.String prefixName)
      Seeks forward to the first ref record lexicographically beyond prefixName that doesn't start with prefixName.
      boolean wasDeleted()
      Whether the current reference was deleted.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RefCursor

        public RefCursor()
    • Method Detail

      • next

        public abstract boolean next()
                              throws java.io.IOException
        Check if another reference is available.
        Returns:
        true if there is another result.
        Throws:
        java.io.IOException - references cannot be read.
      • seekPastPrefix

        public abstract void seekPastPrefix​(java.lang.String prefixName)
                                     throws java.io.IOException
        Seeks forward to the first ref record lexicographically beyond prefixName that doesn't start with prefixName. If there are no more results, skipping some refs won't add new results. E.g if we create a RefCursor that returns only results with a specific prefix, skipping that prefix won't give results that are not part of the original prefix.
        Parameters:
        prefixName - prefix that should be skipped. All previous refs before it will be skipped.
        Throws:
        java.io.IOException - references cannot be read.
      • getRef

        public abstract Ref getRef()
        Get reference at the current position.
        Returns:
        reference at the current position.
      • wasDeleted

        public boolean wasDeleted()
        Whether the current reference was deleted.
        Returns:
        true if the current reference was deleted.
      • close

        public abstract void close()
        Specified by:
        close in interface java.lang.AutoCloseable