ChecksumIndexInput

extends IndexInput

java.lang.Object
↳	org.apache.lucene.store.IndexInput
	↳	org.apache.lucene.store.ChecksumIndexInput

Class Overview

Writes bytes through to a primary IndexOutput, computing checksum as it goes. Note that you cannot use seek().

Summary

Public Constructors
	ChecksumIndexInput(IndexInput main)

Public Methods
void	close() Closes the stream to further operations.
long	getChecksum()
long	getFilePointer() Returns the current position in this file, where the next read will occur.
long	length() The number of bytes in the file.
byte	readByte() Reads and returns a single byte.
void	readBytes(byte[] b, int offset, int len) Reads a specified number of bytes into an array at the specified offset.
void	seek(long pos) Sets current position in this file, where the next read will occur.

[Expand]

Inherited Methods

From class org.apache.lucene.store.IndexInput

Object	clone() Returns a clone of this stream.
abstract void	close() Closes the stream to further operations.
abstract long	getFilePointer() Returns the current position in this file, where the next read will occur.
abstract long	length() The number of bytes in the file.
abstract byte	readByte() Reads and returns a single byte.
abstract void	readBytes(byte[] b, int offset, int len) Reads a specified number of bytes into an array at the specified offset.
void	readBytes(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).
void	readChars(char[] buffer, int start, int length) This method is deprecated. -- please use readString or readBytes instead, and construct the string from those utf8 bytes
int	readInt() Reads four bytes and returns an int.
long	readLong() Reads eight bytes and returns a long.
String	readString() Reads a string.
Map<String, String>	readStringStringMap()
int	readVInt() Reads an int stored in variable-length format.
long	readVLong() Reads a long stored in variable-length format.
abstract void	seek(long pos) Sets current position in this file, where the next read will occur.
void	setModifiedUTF8StringsMode() Call this if readString should read characters stored in the old modified UTF8 format (length in java chars and java's modified UTF8 encoding).
void	skipChars(int length) This method is deprecated. this method operates on old "modified utf8" encoded strings

From class java.lang.Object

From interface java.io.Closeable

Public Constructors

public ChecksumIndexInput (IndexInput main)

Public Methods

public void close ()

Closes the stream to further operations.

Throws

IOException

public long getChecksum ()

public long getFilePointer ()

Returns the current position in this file, where the next read will occur.

public long length ()

The number of bytes in the file.

public byte readByte ()

Reads and returns a single byte.

Throws

IOException

public void readBytes (byte[] b, int offset, int len)

Reads a specified number of bytes into an array at the specified offset.

Parameters

b	the array to read bytes into
offset	the offset in the array to start storing bytes
len	the number of bytes to read

Throws

IOException

public void seek (long pos)

Sets current position in this file, where the next read will occur.

Classes

Exceptions

ChecksumIndexInput

Class Overview

Summary

Public Constructors

public ChecksumIndexInput (IndexInput main)

Public Methods

public void close ()

Throws

public long getChecksum ()

public long getFilePointer ()

public long length ()

public byte readByte ()

Throws

public void readBytes (byte[] b, int offset, int len)

Parameters

Throws

public void seek (long pos)