Package org.apache.lucene.store
Class BufferedChecksumIndexInput
java.lang.Object
org.apache.lucene.store.DataInput
org.apache.lucene.store.IndexInput
org.apache.lucene.store.ChecksumIndexInput
org.apache.lucene.store.BufferedChecksumIndexInput
- All Implemented Interfaces:
Closeable,AutoCloseable,Cloneable
Simple implementation of
ChecksumIndexInput that wraps another input and delegates calls.-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new BufferedChecksumIndexInput -
Method Summary
Modifier and TypeMethodDescriptionclone()Returns a clone of this stream.voidclose()Closes the stream to further operations.longReturns the current checksum valuelongReturns the current position in this file, where the next read will occur.longlength()The number of bytes in the file.bytereadByte()Reads and returns a single byte.voidreadBytes(byte[] b, int offset, int len) Reads a specified number of bytes into an array at the specified offset.intreadInt()Reads four bytes and returns an int (LE byte order).longreadLong()Reads eight bytes and returns a long (LE byte order).voidreadLongs(long[] dst, int offset, int length) Read a specified number of longs.shortReads two bytes and returns a short (LE byte order).Creates a slice of this index input, with the given description, offset, and length.Methods inherited from class org.apache.lucene.store.ChecksumIndexInput
seekMethods inherited from class org.apache.lucene.store.IndexInput
getFullSliceDescription, isLoaded, prefetch, randomAccessSlice, skipBytes, slice, toString, updateReadAdviceMethods inherited from class org.apache.lucene.store.DataInput
readBytes, readFloats, readGroupVInt, readInts, readMapOfStrings, readSetOfStrings, readString, readVInt, readVLong, readZInt, readZLong
-
Constructor Details
-
BufferedChecksumIndexInput
Creates a new BufferedChecksumIndexInput
-
-
Method Details
-
readByte
Description copied from class:DataInputReads and returns a single byte.- Specified by:
readBytein classDataInput- Throws:
IOException- See Also:
-
readBytes
Description 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:
-
readShort
Description copied from class:DataInputReads two bytes and returns a short (LE byte order).- Overrides:
readShortin classDataInput- Throws:
IOException- See Also:
-
readInt
Description copied from class:DataInputReads four bytes and returns an int (LE byte order).- Overrides:
readIntin classDataInput- Throws:
IOException- See Also:
-
readLong
Description copied from class:DataInputReads eight bytes and returns a long (LE byte order).- Overrides:
readLongin classDataInput- Throws:
IOException- See Also:
-
readLongs
Description copied from class:DataInputRead a specified number of longs.- Overrides:
readLongsin classDataInput- Throws:
IOException
-
getChecksum
public long getChecksum()Description copied from class:ChecksumIndexInputReturns the current checksum value- Specified by:
getChecksumin classChecksumIndexInput
-
close
Description 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:
-
length
public long length()Description copied from class:IndexInputThe number of bytes in the file.- Specified by:
lengthin classIndexInput
-
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
-
slice
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
-