org.apache.lucene.store

Class BufferedIndexInput

java.lang.Object

org.apache.lucene.store.IndexInput

org.apache.lucene.store.BufferedIndexInput

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

InputStream

public abstract class BufferedIndexInput
extends IndexInput

Base implementation class for buffered IndexInput.

Constructor Summary

Constructors

Constructor and Description
BufferedIndexInput()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Returns a clone of this stream.
long	getFilePointer() Returns the current position in this file, where the next read will occur.
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.
protected 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.
protected abstract void	seekInternal(long pos) Expert: implements seek.

Methods inherited from class org.apache.lucene.store.IndexInput

close, length, readChars, readInt, readLong, readString, readVInt, readVLong

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferedIndexInput

public BufferedIndexInput()

Method Detail

readByte

public byte readByte()
              throws IOException

Description copied from class: IndexInput

Reads and returns a single byte.

Specified by:

readByte in class IndexInput

Throws:

IOException

See Also:

IndexOutput.writeByte(byte)

readBytes

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

Description copied from class: IndexInput

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

Specified by:

readBytes in class IndexInput

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

See Also:

IndexOutput.writeBytes(byte[],int)

readInternal

protected abstract void readInternal(byte[] b,
                int offset,
                int length)
                              throws IOException

Expert: implements buffer refill. Reads bytes from the current position in the input.

Parameters:

b - the array to read bytes into

offset - the offset in the array to start storing bytes

length - the number of bytes to read

Throws:

IOException

getFilePointer

public long getFilePointer()

Description copied from class: IndexInput

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

Specified by:

getFilePointer in class IndexInput

See Also:

IndexInput.seek(long)

seek

public void seek(long pos)
          throws IOException

Description copied from class: IndexInput

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

Specified by:

seek in class IndexInput

Throws:

IOException

See Also:

IndexInput.getFilePointer()

seekInternal

protected abstract void seekInternal(long pos)
                              throws IOException

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

Throws:

IOException

See Also:

readInternal(byte[],int,int)

clone

public Object clone()

Description copied from class: IndexInput

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.

Overrides:

clone in class IndexInput