protected static class

SimpleFSDirectory.SimpleFSIndexInput

extends BufferedIndexInput

java.lang.Object
↳	org.apache.lucene.store.IndexInput
	↳	org.apache.lucene.store.BufferedIndexInput
		↳	org.apache.lucene.store.SimpleFSDirectory.SimpleFSIndexInput

Known Direct Subclasses

NIOFSDirectory.NIOFSIndexInput

Summary

Nested Classes
class	SimpleFSDirectory.SimpleFSIndexInput.Descriptor

[Expand]

Inherited Constants

From class org.apache.lucene.store.BufferedIndexInput

Fields
protected final int	chunkSize
protected final SimpleFSDirectory.SimpleFSIndexInput.Descriptor	file

[Expand]

Inherited Fields

From class org.apache.lucene.store.BufferedIndexInput

Public Constructors
	SimpleFSDirectory.SimpleFSIndexInput(File path, int bufferSize, int chunkSize)

Public Methods
Object	clone() Returns a clone of this stream.
void	close() Closes the stream to further operations.
long	length() The number of bytes in the file.

Protected Methods
void	readInternal(byte[] b, int offset, int len) IndexInput methods
void	seekInternal(long position) Expert: implements seek.

[Expand]

Inherited Methods

From class org.apache.lucene.store.BufferedIndexInput

Object	clone() Returns a clone of this stream.
int	getBufferSize() Returns buffer size.
long	getFilePointer() Returns the current position in this file, where the next read will occur.
void	newBuffer(byte[] newBuffer)
byte	readByte() Reads and returns a single byte.
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	readBytes(byte[] b, int offset, int len) Reads a specified number of bytes into an array at the specified offset.
abstract void	readInternal(byte[] b, int offset, int length) Expert: implements buffer refill.
void	seek(long pos) Sets current position in this file, where the next read will occur.
abstract void	seekInternal(long pos) Expert: implements seek.
void	setBufferSize(int newSize) Change the buffer size used by this IndexInput

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

Fields

protected final int chunkSize

protected final SimpleFSDirectory.SimpleFSIndexInput.Descriptor file

Public Constructors

public SimpleFSDirectory.SimpleFSIndexInput (File path, int bufferSize, int chunkSize)

Throws

IOException

Public Methods

public Object clone ()

Returns 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.

public void close ()

Closes the stream to further operations.

Throws

IOException

public long length ()

The number of bytes in the file.

Protected Methods

protected void readInternal (byte[] b, int offset, int len)

IndexInput methods

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

protected void seekInternal (long position)

Expert: implements seek. Sets current position in this file, where the next readInternal(byte[], int, int) will occur.

Classes

Exceptions

SimpleFSDirectory.SimpleFSIndexInput

Summary

Fields

protected final int chunkSize

protected final SimpleFSDirectory.SimpleFSIndexInput.Descriptor file

Public Constructors

public SimpleFSDirectory.SimpleFSIndexInput (File path, int bufferSize, int chunkSize)

Throws

Public Methods

public Object clone ()

public void close ()

Throws

public long length ()

Protected Methods

protected void readInternal (byte[] b, int offset, int len)

Parameters

Throws

protected void seekInternal (long position)