Package org.apache.lucene.store
Class ChecksumIndexInput
- java.lang.Object
-
- org.apache.lucene.store.DataInput
-
- org.apache.lucene.store.IndexInput
-
- org.apache.lucene.store.ChecksumIndexInput
-
- All Implemented Interfaces:
Closeable,AutoCloseable,Cloneable
- Direct Known Subclasses:
BufferedChecksumIndexInput
public abstract class ChecksumIndexInput extends IndexInput
Extension of IndexInput, computing checksum as it goes. Callers can retrieve the checksum viagetChecksum().
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedChecksumIndexInput(String resourceDescription)resourceDescription should be a non-null, opaque string describing this resource; it's returned fromIndexInput.toString().
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract longgetChecksum()Returns the current checksum valuevoidseek(long pos)Sets current position in this file, where the next read will occur.-
Methods inherited from class org.apache.lucene.store.IndexInput
clone, close, getFilePointer, getFullSliceDescription, length, randomAccessSlice, skipBytes, slice, toString
-
Methods inherited from class org.apache.lucene.store.DataInput
readByte, readBytes, readBytes, readFloats, readGroupVInt, readGroupVInts, readInt, readInts, readLong, readLongs, readMapOfStrings, readSetOfStrings, readShort, readString, readVInt, readVLong, readZInt, readZLong
-
-
-
-
Constructor Detail
-
ChecksumIndexInput
protected ChecksumIndexInput(String resourceDescription)
resourceDescription should be a non-null, opaque string describing this resource; it's returned fromIndexInput.toString().
-
-
Method Detail
-
getChecksum
public abstract long getChecksum() throws IOExceptionReturns the current checksum value- Throws:
IOException
-
seek
public void seek(long pos) throws IOExceptionSets 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.ChecksumIndexInputcan only seek forward and seeks are expensive since they imply to read bytes in-between the current position and the target position in order to update the checksum.- Specified by:
seekin classIndexInput- Throws:
IOException- See Also:
IndexInput.getFilePointer()
-
-