Class ByteBuffersIndexInput
- java.lang.Object
-
- org.apache.lucene.store.DataInput
-
- org.apache.lucene.store.IndexInput
-
- org.apache.lucene.store.ByteBuffersIndexInput
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Cloneable,RandomAccessInput
public final class ByteBuffersIndexInput extends IndexInput implements RandomAccessInput
-
-
Constructor Summary
Constructors Constructor Description ByteBuffersIndexInput(ByteBuffersDataInput in, String resourceDescription)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IndexInputclone()Returns a clone of this stream.voidclose()Closes the stream to further operations.longgetFilePointer()Returns the current position in this file, where the next read will occur.longlength()The number of bytes in the file.RandomAccessInputrandomAccessSlice(long offset, long length)Creates a random-access slice of this index input, with the given offset and length.bytereadByte()Reads and returns a single byte.bytereadByte(long pos)Reads a byte at the given position in the filevoidreadBytes(byte[] b, int offset, int len)Reads a specified number of bytes into an array at the specified offset.voidreadBytes(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).voidreadFloats(float[] floats, int offset, int len)Reads a specified number of floats into an array at the specified offset.protected voidreadGroupVInt(long[] dst, int offset)Override if you have a efficient implementation.intreadInt()Reads four bytes and returns an int (LE byte order).intreadInt(long pos)Reads an integer (LE byte order) at the given position in the filelongreadLong()Reads eight bytes and returns a long (LE byte order).longreadLong(long pos)Reads a long (LE byte order) at the given position in the filevoidreadLongs(long[] dst, int offset, int length)Read a specified number of longs.Map<String,String>readMapOfStrings()Reads a Map<String,String> previously written withDataOutput.writeMapOfStrings(Map).Set<String>readSetOfStrings()Reads a Set<String> previously written withDataOutput.writeSetOfStrings(Set).shortreadShort()Reads two bytes and returns a short (LE byte order).shortreadShort(long pos)Reads a short (LE byte order) at the given position in the fileStringreadString()Reads a string.intreadVInt()Reads an int stored in variable-length format.longreadVLong()Reads a long stored in variable-length format.intreadZInt()Read azig-zag-encodedvariable-lengthinteger.longreadZLong()Read azig-zag-encodedvariable-lengthinteger.voidseek(long pos)Sets current position in this file, where the next read will occur.voidskipBytes(long numBytes)Skip overnumBytesbytes.ByteBuffersIndexInputslice(String sliceDescription, long offset, long length)Creates a slice of this index input, with the given description, offset, and length.-
Methods inherited from class org.apache.lucene.store.IndexInput
getFullSliceDescription, toString
-
Methods inherited from class org.apache.lucene.store.DataInput
readGroupVInts, readInts
-
-
-
-
Constructor Detail
-
ByteBuffersIndexInput
public ByteBuffersIndexInput(ByteBuffersDataInput in, String resourceDescription)
-
-
Method Detail
-
close
public void close() throws IOExceptionDescription copied from class:IndexInputCloses the stream to further operations.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein classIndexInput- Throws:
IOException
-
getFilePointer
public long getFilePointer()
Description copied from class:IndexInputReturns the current position in this file, where the next read will occur.- Specified by:
getFilePointerin classIndexInput- See Also:
IndexInput.seek(long)
-
seek
public void seek(long pos) throws IOExceptionDescription copied from class:IndexInputSets current position in this file, where the next read will occur. If this is beyond the end of the file then this will throwEOFExceptionand then the stream is in an undetermined state.- Specified by:
seekin classIndexInput- Throws:
IOException- See Also:
IndexInput.getFilePointer()
-
length
public long length()
Description copied from class:IndexInputThe number of bytes in the file.- Specified by:
lengthin interfaceRandomAccessInput- Specified by:
lengthin classIndexInput
-
slice
public ByteBuffersIndexInput slice(String sliceDescription, long offset, long length) throws IOException
Description copied from class:IndexInputCreates a slice of this index input, with the given description, offset, and length. The slice is sought to the beginning.- Specified by:
slicein classIndexInput- Throws:
IOException
-
readByte
public byte readByte() throws IOExceptionDescription copied from class:DataInputReads and returns a single byte.- Specified by:
readBytein classDataInput- Throws:
IOException- See Also:
DataOutput.writeByte(byte)
-
readBytes
public void readBytes(byte[] b, int offset, int len) throws IOExceptionDescription copied from class:DataInputReads a specified number of bytes into an array at the specified offset.- Specified by:
readBytesin 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:
DataOutput.writeBytes(byte[],int)
-
randomAccessSlice
public RandomAccessInput randomAccessSlice(long offset, long length) throws IOException
Description copied from class:IndexInputCreates a random-access slice of this index input, with the given offset and length.The default implementation calls
IndexInput.slice(java.lang.String, long, long), and it doesn't support random access, it implements absolute reads as seek+read.- Overrides:
randomAccessSlicein classIndexInput- Throws:
IOException
-
readBytes
public void readBytes(byte[] b, int offset, int len, boolean useBuffer) throws IOExceptionDescription copied from class:DataInputReads 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 onlyBufferedIndexInputrespects this parameter.- Overrides:
readBytesin 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:
IOException- See Also:
DataOutput.writeBytes(byte[],int)
-
readShort
public short readShort() throws IOExceptionDescription copied from class:DataInputReads two bytes and returns a short (LE byte order).- Overrides:
readShortin classDataInput- Throws:
IOException- See Also:
DataOutput.writeShort(short),BitUtil.VH_LE_SHORT
-
readInt
public int readInt() throws IOExceptionDescription copied from class:DataInputReads four bytes and returns an int (LE byte order).- Overrides:
readIntin classDataInput- Throws:
IOException- See Also:
DataOutput.writeInt(int),BitUtil.VH_LE_INT
-
readVInt
public int readVInt() throws IOExceptionDescription copied from class:DataInputReads 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:
readVIntin classDataInput- Throws:
IOException- See Also:
DataOutput.writeVInt(int)
-
readZInt
public int readZInt() throws IOExceptionDescription copied from class:DataInputRead azig-zag-encodedvariable-lengthinteger.- Overrides:
readZIntin classDataInput- Throws:
IOException- See Also:
DataOutput.writeZInt(int)
-
readLong
public long readLong() throws IOExceptionDescription copied from class:DataInputReads eight bytes and returns a long (LE byte order).- Overrides:
readLongin classDataInput- Throws:
IOException- See Also:
DataOutput.writeLong(long),BitUtil.VH_LE_LONG
-
readVLong
public long readVLong() throws IOExceptionDescription copied from class:DataInputReads 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:
readVLongin classDataInput- Throws:
IOException- See Also:
DataOutput.writeVLong(long)
-
readZLong
public long readZLong() throws IOExceptionDescription copied from class:DataInputRead azig-zag-encodedvariable-lengthinteger. Reads between one and ten bytes.- Overrides:
readZLongin classDataInput- Throws:
IOException- See Also:
DataOutput.writeZLong(long)
-
readString
public String readString() throws IOException
Description copied from class:DataInputReads a string.- Overrides:
readStringin classDataInput- Throws:
IOException- See Also:
DataOutput.writeString(String)
-
readMapOfStrings
public Map<String,String> readMapOfStrings() throws IOException
Description copied from class:DataInputReads a Map<String,String> previously written withDataOutput.writeMapOfStrings(Map).- Overrides:
readMapOfStringsin classDataInput- Returns:
- An immutable map containing the written contents.
- Throws:
IOException
-
readSetOfStrings
public Set<String> readSetOfStrings() throws IOException
Description copied from class:DataInputReads a Set<String> previously written withDataOutput.writeSetOfStrings(Set).- Overrides:
readSetOfStringsin classDataInput- Returns:
- An immutable set containing the written contents.
- Throws:
IOException
-
skipBytes
public void skipBytes(long numBytes) throws IOExceptionDescription copied from class:IndexInputSkip overnumBytesbytes. This method may skip bytes in whatever way is most optimal, and may not have the same behavior as reading the skipped bytes. In general, negativenumBytesare not supported.Behavior is functionally equivalent to seeking to
getFilePointer() + numBytes.- Overrides:
skipBytesin classIndexInput- Throws:
IOException- See Also:
IndexInput.getFilePointer(),IndexInput.seek(long)
-
readByte
public byte readByte(long pos) throws IOExceptionDescription copied from interface:RandomAccessInputReads a byte at the given position in the file- Specified by:
readBytein interfaceRandomAccessInput- Throws:
IOException- See Also:
DataInput.readByte()
-
readShort
public short readShort(long pos) throws IOExceptionDescription copied from interface:RandomAccessInputReads a short (LE byte order) at the given position in the file- Specified by:
readShortin interfaceRandomAccessInput- Throws:
IOException- See Also:
DataInput.readShort(),BitUtil.VH_LE_SHORT
-
readInt
public int readInt(long pos) throws IOExceptionDescription copied from interface:RandomAccessInputReads an integer (LE byte order) at the given position in the file- Specified by:
readIntin interfaceRandomAccessInput- Throws:
IOException- See Also:
DataInput.readInt(),BitUtil.VH_LE_INT
-
readLong
public long readLong(long pos) throws IOExceptionDescription copied from interface:RandomAccessInputReads a long (LE byte order) at the given position in the file- Specified by:
readLongin interfaceRandomAccessInput- Throws:
IOException- See Also:
DataInput.readLong(),BitUtil.VH_LE_LONG
-
readFloats
public void readFloats(float[] floats, int offset, int len) throws IOExceptionDescription copied from class:DataInputReads a specified number of floats into an array at the specified offset.- Overrides:
readFloatsin 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
-
readLongs
public void readLongs(long[] dst, int offset, int length) throws IOExceptionDescription copied from class:DataInputRead a specified number of longs.- Overrides:
readLongsin classDataInput- Throws:
IOException
-
readGroupVInt
protected void readGroupVInt(long[] dst, int offset) throws IOExceptionDescription copied from class:DataInputOverride if you have a efficient implementation. In general this is when the input supports random access.- Overrides:
readGroupVIntin classDataInput- Throws:
IOException
-
clone
public IndexInput clone()
Description copied from class:IndexInputReturns 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 callIndexInput.close()on the original object.If you access the cloned IndexInput after closing the original object, any
readXXXmethods will throwAlreadyClosedException.This method is NOT thread safe, so if the current
IndexInputis being used by one thread whilecloneis called by another, disaster could strike.- Overrides:
clonein classIndexInput
-
-