Class IndexInput

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, java.lang.Cloneable
    Direct Known Subclasses:
    BufferedIndexInput, ChecksumIndexInput, RAMInputStream

    public abstract class IndexInput
    extends DataInput
    implements java.lang.Cloneable, java.io.Closeable
    Abstract base class for input from a file in a Directory. A random-access input stream. Used for all Lucene index input operations.

    IndexInput may only be used from one thread, because it is not thread safe (it keeps internal state like file position). To allow multithreaded use, every IndexInput instance must be cloned before used in another thread. Subclasses must therefore implement clone(), returning a new IndexInput which operates on the same underlying resource, but positioned independently. Lucene never closes cloned IndexInputs, it will only do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.

    See Also:
    Directory
    • Method Detail

      • close

        public abstract void close()
                            throws java.io.IOException
        Closes the stream to further operations.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException
      • getFilePointer

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

        public abstract void seek​(long pos)
                           throws java.io.IOException
        Sets current position in this file, where the next read will occur.
        Throws:
        java.io.IOException
        See Also:
        getFilePointer()
      • length

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

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • clone

        public IndexInput clone()
        Returns a clone of this stream.

        Clones of a stream access the same data, and are positioned at the same point as the stream they were cloned from.

        Expert: Subclasses must ensure that clones may be positioned at different points in the input from each other and from the stream they were cloned from.

        Warning: Lucene never closes cloned IndexInputs, it will only do this on the original one. The original instance must take care that cloned instances throw AlreadyClosedException when the original one is closed.

        Overrides:
        clone in class DataInput