- All Implemented Interfaces:
Closeable
,AutoCloseable
,Cloneable
,RandomAccessInput
- Direct Known Subclasses:
ByteBufferIndexInput.MultiBufferImpl
,ByteBufferIndexInput.SingleBufferImpl
Because Java's ByteBuffer uses an int to address the values, it's necessary to access a file greater Integer.MAX_VALUE in size using multiple byte buffers.
For efficiency, this class requires that the buffers are a power-of-two (chunkSizePower
).
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
Deprecated.This class adds offset support to ByteBufferIndexInput, which is needed for slices.(package private) static final class
Deprecated.Optimization of ByteBufferIndexInput for when there is only one buffer -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ByteBuffer[]
Deprecated.protected final long
Deprecated.protected final int
Deprecated.protected ByteBuffer
Deprecated.protected int
Deprecated.private FloatBuffer[]
Deprecated.private IntBuffer[]
Deprecated.private LongBuffer[]
Deprecated.private static final FloatBuffer
Deprecated.private static final IntBuffer
Deprecated.private static final LongBuffer
Deprecated.protected final ByteBufferGuard
Deprecated.protected boolean
Deprecated.protected final long
Deprecated. -
Constructor Summary
ConstructorsConstructorDescriptionByteBufferIndexInput
(String resourceDescription, ByteBuffer[] buffers, long length, int chunkSizePower, ByteBufferGuard guard) Deprecated. -
Method Summary
Modifier and TypeMethodDescription(package private) AlreadyClosedException
Deprecated.protected ByteBufferIndexInput
buildSlice
(String sliceDescription, long offset, long length) Deprecated.Builds the actual sliced IndexInput (may apply extra offset in subclasses).private ByteBuffer[]
buildSlice
(ByteBuffer[] buffers, long offset, long length) Deprecated.Returns a sliced view from a set of already-existing buffers: the last buffer's limit() will be correct, but you must deal with offset separately (the first buffer will not be adjusted)final ByteBufferIndexInput
clone()
Deprecated.Returns a clone of this stream.final void
close()
Deprecated.Closes the stream to further operations.long
Deprecated.Returns the current position in this file, where the next read will occur.(package private) RuntimeException
handlePositionalIOOBE
(RuntimeException unused, String action, long pos) Deprecated.final long
length()
Deprecated.The number of bytes in the file.protected ByteBufferIndexInput
newCloneInstance
(String newResourceDescription, ByteBuffer[] newBuffers, int offset, long length) Deprecated.Factory method that creates a suitable implementation of this class for the given ByteBuffers.static ByteBufferIndexInput
newInstance
(String resourceDescription, ByteBuffer[] buffers, long length, int chunkSizePower, ByteBufferGuard guard) Deprecated.final byte
readByte()
Deprecated.Reads and returns a single byte.byte
readByte
(long pos) Deprecated.Reads a byte at the given position in the filefinal void
readBytes
(byte[] b, int offset, int len) Deprecated.Reads a specified number of bytes into an array at the specified offset.final void
readFloats
(float[] floats, int offset, int len) Deprecated.Reads a specified number of floats into an array at the specified offset.final int
readInt()
Deprecated.Reads four bytes and returns an int (LE byte order).int
readInt
(long pos) Deprecated.Reads an integer (LE byte order) at the given position in the filevoid
readInts
(int[] dst, int offset, int length) Deprecated.Reads a specified number of ints into an array at the specified offset.final long
readLong()
Deprecated.Reads eight bytes and returns a long (LE byte order).long
readLong
(long pos) Deprecated.Reads a long (LE byte order) at the given position in the filefinal void
readLongs
(long[] dst, int offset, int length) Deprecated.Read a specified number of longs.final short
Deprecated.Reads two bytes and returns a short (LE byte order).short
readShort
(long pos) Deprecated.Reads a short (LE byte order) at the given position in the filefinal int
readVInt()
Deprecated.Reads an int stored in variable-length format.final long
Deprecated.Reads a long stored in variable-length format.void
seek
(long pos) Deprecated.Sets current position in this file, where the next read will occur.protected void
setCurBuf
(ByteBuffer curBuf) Deprecated.private void
setPos
(long pos, int bi) Deprecated.final ByteBufferIndexInput
Deprecated.Creates a slice of this index input, with the given description, offset, and length.private void
Deprecated.Called to remove all references to byte buffers, so we can throw AlreadyClosed on NPE.Methods inherited from class org.apache.lucene.store.IndexInput
getFullSliceDescription, randomAccessSlice, skipBytes, toString
Methods inherited from class org.apache.lucene.store.DataInput
readBytes, readGroupVInt, readGroupVInts, readMapOfStrings, readSetOfStrings, readString, readZInt, readZLong
-
Field Details
-
EMPTY_FLOATBUFFER
Deprecated. -
EMPTY_LONGBUFFER
Deprecated. -
EMPTY_INTBUFFER
Deprecated. -
length
protected final long lengthDeprecated. -
chunkSizeMask
protected final long chunkSizeMaskDeprecated. -
chunkSizePower
protected final int chunkSizePowerDeprecated. -
guard
Deprecated. -
buffers
Deprecated. -
curBufIndex
protected int curBufIndexDeprecated. -
curBuf
Deprecated. -
curLongBufferViews
Deprecated. -
curIntBufferViews
Deprecated. -
curFloatBufferViews
Deprecated. -
isClone
protected boolean isCloneDeprecated.
-
-
Constructor Details
-
ByteBufferIndexInput
ByteBufferIndexInput(String resourceDescription, ByteBuffer[] buffers, long length, int chunkSizePower, ByteBufferGuard guard) Deprecated.
-
-
Method Details
-
newInstance
public static ByteBufferIndexInput newInstance(String resourceDescription, ByteBuffer[] buffers, long length, int chunkSizePower, ByteBufferGuard guard) Deprecated. -
setCurBuf
Deprecated. -
handlePositionalIOOBE
RuntimeException handlePositionalIOOBE(RuntimeException unused, String action, long pos) throws IOException Deprecated.- Throws:
IOException
-
alreadyClosed
Deprecated. -
readByte
Deprecated.Description copied from class:DataInput
Reads and returns a single byte.- Specified by:
readByte
in classDataInput
- Throws:
IOException
- See Also:
-
readBytes
Deprecated.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:
IOException
- See Also:
-
readLongs
Deprecated.Description copied from class:DataInput
Read a specified number of longs.- Overrides:
readLongs
in classDataInput
- Throws:
IOException
-
readInts
Deprecated.Description copied from class:DataInput
Reads a specified number of ints into an array at the specified offset.- Overrides:
readInts
in classDataInput
- Parameters:
dst
- the array to read bytes intooffset
- the offset in the array to start storing intslength
- the number of ints to read- Throws:
IOException
-
readFloats
Deprecated.Description copied from class:DataInput
Reads a specified number of floats into an array at the specified offset.- Overrides:
readFloats
in classDataInput
- Parameters:
floats
- the array to read bytes intooffset
- the offset in the array to start storing floatslen
- the number of floats to read- Throws:
IOException
-
readShort
Deprecated.Description copied from class:DataInput
Reads two bytes and returns a short (LE byte order).- Overrides:
readShort
in classDataInput
- Throws:
IOException
- See Also:
-
readInt
Deprecated.Description copied from class:DataInput
Reads four bytes and returns an int (LE byte order).- Overrides:
readInt
in classDataInput
- Throws:
IOException
- See Also:
-
readVInt
Deprecated.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 supported, but should be avoided.The format is described further in
DataOutput.writeVInt(int)
.- Overrides:
readVInt
in classDataInput
- Throws:
IOException
- See Also:
-
readVLong
Deprecated.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:
IOException
- See Also:
-
readLong
Deprecated.Description copied from class:DataInput
Reads eight bytes and returns a long (LE byte order).- Overrides:
readLong
in classDataInput
- Throws:
IOException
- See Also:
-
getFilePointer
public long getFilePointer()Deprecated.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:
-
seek
Deprecated.Description copied from class:IndexInput
Sets current position in this file, where the next read will occur. If this is beyond the end of the file then this will throwEOFException
and then the stream is in an undetermined state.- Specified by:
seek
in classIndexInput
- Throws:
IOException
- See Also:
-
readByte
Deprecated.Description copied from interface:RandomAccessInput
Reads a byte at the given position in the file- Specified by:
readByte
in interfaceRandomAccessInput
- Throws:
IOException
- See Also:
-
setPos
Deprecated.- Throws:
IOException
-
readShort
Deprecated.Description copied from interface:RandomAccessInput
Reads a short (LE byte order) at the given position in the file- Specified by:
readShort
in interfaceRandomAccessInput
- Throws:
IOException
- See Also:
-
readInt
Deprecated.Description copied from interface:RandomAccessInput
Reads an integer (LE byte order) at the given position in the file- Specified by:
readInt
in interfaceRandomAccessInput
- Throws:
IOException
- See Also:
-
readLong
Deprecated.Description copied from interface:RandomAccessInput
Reads a long (LE byte order) at the given position in the file- Specified by:
readLong
in interfaceRandomAccessInput
- Throws:
IOException
- See Also:
-
length
public final long length()Deprecated.Description copied from class:IndexInput
The number of bytes in the file.- Specified by:
length
in interfaceRandomAccessInput
- Specified by:
length
in classIndexInput
-
clone
Deprecated.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 callIndexInput.close()
on the original object.If you access the cloned IndexInput after closing the original object, any
readXXX
methods will throwAlreadyClosedException
.This method is NOT thread safe, so if the current
IndexInput
is being used by one thread whileclone
is called by another, disaster could strike.- Overrides:
clone
in classIndexInput
-
slice
Deprecated.Creates a slice of this index input, with the given description, offset, and length. The slice is seeked to the beginning.- Specified by:
slice
in classIndexInput
-
buildSlice
Deprecated.Builds the actual sliced IndexInput (may apply extra offset in subclasses). * -
newCloneInstance
protected ByteBufferIndexInput newCloneInstance(String newResourceDescription, ByteBuffer[] newBuffers, int offset, long length) Deprecated.Factory method that creates a suitable implementation of this class for the given ByteBuffers. -
buildSlice
Deprecated.Returns a sliced view from a set of already-existing buffers: the last buffer's limit() will be correct, but you must deal with offset separately (the first buffer will not be adjusted) -
close
Deprecated.Description copied from class:IndexInput
Closes the stream to further operations.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in classIndexInput
- Throws:
IOException
-
unsetBuffers
private void unsetBuffers()Deprecated.Called to remove all references to byte buffers, so we can throw AlreadyClosed on NPE.
-
instanceof
checks). InMMapDirectory
it was replaced byMemorySegment
basedIndexInput
implementations and will be no longer required in Lucene 10.