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
public class BufferedChecksumIndexInput extends ChecksumIndexInput
Simple implementation ofChecksumIndexInputthat wraps another input and delegates calls.
-
-
Constructor Summary
Constructors Constructor Description BufferedChecksumIndexInput(IndexInput main)Creates a new BufferedChecksumIndexInput
-
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.longgetChecksum()Returns the current checksum valuelonggetFilePointer()Returns 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.IndexInputslice(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.ChecksumIndexInput
seek
-
Methods inherited from class org.apache.lucene.store.IndexInput
getFullSliceDescription, randomAccessSlice, skipBytes, toString
-
Methods inherited from class org.apache.lucene.store.DataInput
readBytes, readFloats, readGroupVInt, readGroupVInts, readInt, readInts, readLong, readLongs, readMapOfStrings, readSetOfStrings, readShort, readString, readVInt, readVLong, readZInt, readZLong
-
-
-
-
Constructor Detail
-
BufferedChecksumIndexInput
public BufferedChecksumIndexInput(IndexInput main)
Creates a new BufferedChecksumIndexInput
-
-
Method Detail
-
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)
-
getChecksum
public long getChecksum()
Description copied from class:ChecksumIndexInputReturns the current checksum value- Specified by:
getChecksumin classChecksumIndexInput
-
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)
-
length
public long length()
Description copied from class:IndexInputThe number of bytes in the file.- Specified by:
lengthin classIndexInput
-
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
-
slice
public IndexInput 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
-
-