Class IndexInput

    • Constructor Detail

      • IndexInput

        @Deprecated
        protected IndexInput()
        Deprecated.
        please pass resourceDescription
      • IndexInput

        protected IndexInput​(String resourceDescription)
        resourceDescription should be a non-null, opaque string describing this resource; it's returned from toString().
    • Method Detail

      • skipChars

        @Deprecated
        public void skipChars​(int length)
                       throws IOException
        Deprecated.
        this method operates on old "modified utf8" encoded strings
        Expert Similar to DataInput.readChars(char[], int, int) but does not do any conversion operations on the bytes it is reading in. It still has to invoke DataInput.readByte() just as DataInput.readChars(char[], int, int) does, but it does not need a buffer to store anything and it does not have to do any of the bitwise operations, since we don't actually care what is in the byte except to determine how many more bytes to read
        Parameters:
        length - The number of chars to read
        Throws:
        IOException
      • getFilePointer

        public abstract long getFilePointer()
        Returns the current position in this file, where the next read will occur.
        See Also:
        seek(long)
      • length

        public abstract long length()
        The number of bytes in the file.
      • copyBytes

        public void copyBytes​(IndexOutput out,
                              long numBytes)
                       throws IOException
        Copies numBytes bytes to the given IndexOutput.

        NOTE: this method uses an intermediate buffer to copy the bytes. Consider overriding it in your implementation, if you can make a better, optimized copy.

        NOTE ensure that there are enough bytes in the input to copy to output. Otherwise, different exceptions may be thrown, depending on the implementation.

        Throws:
        IOException