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:
java.io.Closeable
,java.lang.AutoCloseable
,java.lang.Cloneable
public abstract class BufferedIndexInput extends IndexInput
Base implementation class for bufferedIndexInput
.
-
-
Field Summary
Fields Modifier and Type Field Description static int
BUFFER_SIZE
Default buffer size set to 1024.static int
MERGE_BUFFER_SIZE
A buffer size for merges set to 4096.
-
Constructor Summary
Constructors Constructor Description BufferedIndexInput(java.lang.String resourceDesc)
BufferedIndexInput(java.lang.String resourceDesc, int bufferSize)
Inits BufferedIndexInput with a specific bufferSizeBufferedIndexInput(java.lang.String resourceDesc, IOContext context)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static int
bufferSize(IOContext context)
Returns default buffer sizes for the givenIOContext
BufferedIndexInput
clone()
Returns a clone of this stream.int
getBufferSize()
Returns buffer size.long
getFilePointer()
Returns the current position in this file, where the next read will occur.byte
readByte()
Reads and returns a single byte.void
readBytes(byte[] b, int offset, int len)
Reads a specified number of bytes into an array at the specified offset.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).int
readInt()
Reads four bytes and returns an int.long
readLong()
Reads eight bytes and returns a long.short
readShort()
Reads two bytes and returns a short.int
readVInt()
Reads an int stored in variable-length format.long
readVLong()
Reads a long stored in variable-length format.void
seek(long pos)
Sets current position in this file, where the next read will occur.void
setBufferSize(int newSize)
Change the buffer size used by this IndexInput-
Methods inherited from class org.apache.lucene.store.IndexInput
close, length, toString
-
Methods inherited from class org.apache.lucene.store.DataInput
readString, readStringSet, readStringStringMap
-
-
-
-
Field Detail
-
BUFFER_SIZE
public static final int BUFFER_SIZE
Default buffer size set to 1024.- See Also:
- Constant Field Values
-
MERGE_BUFFER_SIZE
public static final int MERGE_BUFFER_SIZE
A buffer size for merges set to 4096.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
BufferedIndexInput
public BufferedIndexInput(java.lang.String resourceDesc)
-
BufferedIndexInput
public BufferedIndexInput(java.lang.String resourceDesc, IOContext context)
-
BufferedIndexInput
public BufferedIndexInput(java.lang.String resourceDesc, int bufferSize)
Inits BufferedIndexInput with a specific bufferSize
-
-
Method Detail
-
readByte
public final byte readByte() throws java.io.IOException
Description copied from class:DataInput
Reads and returns a single byte.- Specified by:
readByte
in classDataInput
- Throws:
java.io.IOException
- See Also:
DataOutput.writeByte(byte)
-
setBufferSize
public final void setBufferSize(int newSize)
Change the buffer size used by this IndexInput
-
getBufferSize
public final int getBufferSize()
Returns buffer size. @see #setBufferSize
-
readBytes
public final void readBytes(byte[] b, int offset, int len) throws java.io.IOException
Description copied from class:DataInput
Reads a specified number of bytes into an array at the specified offset.- Specified by:
readBytes
in classDataInput
- Parameters:
b
- the array to read bytes intooffset
- the offset in the array to start storing byteslen
- the number of bytes to read- Throws:
java.io.IOException
- See Also:
DataOutput.writeBytes(byte[],int)
-
readBytes
public final void readBytes(byte[] b, int offset, int len, boolean useBuffer) throws java.io.IOException
Description copied from class:DataInput
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). Currently onlyBufferedIndexInput
respects this parameter.- Overrides:
readBytes
in classDataInput
- Parameters:
b
- the array to read bytes intooffset
- the offset in the array to start storing byteslen
- the number of bytes to readuseBuffer
- set to false if the caller will handle buffering.- Throws:
java.io.IOException
- See Also:
DataOutput.writeBytes(byte[],int)
-
readShort
public final short readShort() throws java.io.IOException
Description copied from class:DataInput
Reads two bytes and returns a short.- Overrides:
readShort
in classDataInput
- Throws:
java.io.IOException
- See Also:
DataOutput.writeByte(byte)
-
readInt
public final int readInt() throws java.io.IOException
Description copied from class:DataInput
Reads four bytes and returns an int.- Overrides:
readInt
in classDataInput
- Throws:
java.io.IOException
- See Also:
DataOutput.writeInt(int)
-
readLong
public final long readLong() throws java.io.IOException
Description copied from class:DataInput
Reads eight bytes and returns a long.- Overrides:
readLong
in classDataInput
- Throws:
java.io.IOException
- See Also:
DataOutput.writeLong(long)
-
readVInt
public final int readVInt() throws java.io.IOException
Description copied from class:DataInput
Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are not supported.The format is described further in
DataOutput.writeVInt(int)
.- Overrides:
readVInt
in classDataInput
- Throws:
java.io.IOException
- See Also:
DataOutput.writeVInt(int)
-
readVLong
public final long readVLong() throws java.io.IOException
Description copied from class:DataInput
Reads a long stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.The format is described further in
DataOutput.writeVInt(int)
.- Overrides:
readVLong
in classDataInput
- Throws:
java.io.IOException
- See Also:
DataOutput.writeVLong(long)
-
getFilePointer
public final long getFilePointer()
Description copied from class:IndexInput
Returns the current position in this file, where the next read will occur.- Specified by:
getFilePointer
in classIndexInput
- See Also:
IndexInput.seek(long)
-
seek
public final void seek(long pos) throws java.io.IOException
Description copied from class:IndexInput
Sets current position in this file, where the next read will occur.- Specified by:
seek
in classIndexInput
- Throws:
java.io.IOException
- See Also:
IndexInput.getFilePointer()
-
clone
public BufferedIndexInput clone()
Description copied from class:IndexInput
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
IndexInput
s, it will only do this on the original one. The original instance must take care that cloned instances throwAlreadyClosedException
when the original one is closed.- Overrides:
clone
in classIndexInput
-
-