Class ReftableReader.RefCursorImpl

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    Enclosing class:
    ReftableReader

    private class ReftableReader.RefCursorImpl
    extends RefCursor
    • Constructor Summary

      Constructors 
      Constructor Description
      RefCursorImpl​(long scanEnd, byte[] match, boolean prefix)  
    • Method Summary

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

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

      • scanEnd

        private final long scanEnd
      • match

        private final byte[] match
      • prefix

        private final boolean prefix
      • ref

        private Ref ref
    • Constructor Detail

      • RefCursorImpl

        RefCursorImpl​(long scanEnd,
                      byte[] match,
                      boolean prefix)
    • Method Detail

      • next

        public boolean next()
                     throws java.io.IOException
        Description copied from class: RefCursor
        Check if another reference is available.
        Specified by:
        next in class RefCursor
        Returns:
        true if there is another result.
        Throws:
        java.io.IOException - references cannot be read.
      • seekPastPrefix

        public void seekPastPrefix​(java.lang.String prefixName)
                            throws java.io.IOException
        Description copied from class: RefCursor
        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.
        Specified by:
        seekPastPrefix in class RefCursor
        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 Ref getRef()
        Description copied from class: RefCursor
        Get reference at the current position.
        Specified by:
        getRef in class RefCursor
        Returns:
        reference at the current position.
      • close

        public void close()
        Description copied from class: RefCursor
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in class RefCursor