Package org.apache.lucene.store

Class BufferedIndexInput

java.lang.Object
org.apache.lucene.store.DataInput
org.apache.lucene.store.IndexInput
org.apache.lucene.store.BufferedIndexInput
All Implemented Interfaces:
Closeable, AutoCloseable, Cloneable, RandomAccessInput
public abstract class BufferedIndexInput extends IndexInput implements RandomAccessInput
Base implementation class for buffered IndexInput.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BUFFER_SIZE
    Default buffer size set to 1024.
    static final int
    MERGE_BUFFER_SIZE
    A buffer size for merges set to 4096.
    static final int
    MIN_BUFFER_SIZE
    Minimum buffer size allowed

  • Constructor Summary

    Constructors
    Constructor
    Description
    BufferedIndexInput(String resourceDesc)
     
    BufferedIndexInput(String resourceDesc, int bufferSize)
    Inits BufferedIndexInput with a specific bufferSize
    BufferedIndexInput(String resourceDesc, IOContext context)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    bufferSize(IOContext context)
    Returns default buffer sizes for the given IOContext
    BufferedIndexInput
    clone()
    Returns a clone of this stream.
    final int
    getBufferSize()
    Returns buffer size.
    final long
    getFilePointer()
    Returns the current position in this file, where the next read will occur.
    final byte
    readByte()
    Reads and returns a single byte.
    final byte
    readByte(long pos)
    Reads a byte at the given position in the file
    final void
    readBytes(byte[] b, int offset, int len)
    Reads a specified number of bytes into an array at the specified offset.
    final void
    readBytes(byte[] b, int offset, int len, boolean useBuffer)
    Reads a specified number of bytes into an array at the specified offset with control over whether the read should be buffered (callers who have their own buffer should pass in "false" for useBuffer).
    final int
    readInt()
    Reads four bytes and returns an int (LE byte order).
    final int
    readInt(long pos)
    Reads an integer (LE byte order) at the given position in the file
    protected abstract void
    readInternal(ByteBuffer b)
    Expert: implements buffer refill.
    final long
    readLong()
    Reads eight bytes and returns a long (LE byte order).
    final long
    readLong(long pos)
    Reads a long (LE byte order) at the given position in the file
    final short
    readShort()
    Reads two bytes and returns a short (LE byte order).
    final short
    readShort(long pos)
    Reads a short (LE byte order) at the given position in the file
    final int
    readVInt()
    Reads an int stored in variable-length format.
    final long
    readVLong()
    Reads a long stored in variable-length format.
    final void
    seek(long pos)
    Sets current position in this file, where the next read will occur.
    protected abstract void
    seekInternal(long pos)
    Expert: implements seek.
    IndexInput
    slice(String sliceDescription, long offset, long length)
    Creates a slice of this index input, with the given description, offset, and length.
    static BufferedIndexInput
    wrap(String sliceDescription, IndexInput other, long offset, long length)
    Wraps a portion of another IndexInput with buffering.

    Methods inherited from class org.apache.lucene.store.IndexInput

    close, getFullSliceDescription, length, randomAccessSlice, skipBytes, toString

    Methods inherited from class org.apache.lucene.store.DataInput

    readFloats, readLongs, readMapOfStrings, readSetOfStrings, readString, readZInt, readZLong

    Methods inherited from class java.lang.Object

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