org.apache.lucene.store

Class BufferedIndexOutput

java.lang.Object

org.apache.lucene.store.DataOutput

org.apache.lucene.store.IndexOutput

org.apache.lucene.store.BufferedIndexOutput

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

FSDirectory.FSIndexOutput

public abstract class BufferedIndexOutput
extends IndexOutput

Base implementation class for buffered IndexOutput.

Constructor Summary

Constructors

Constructor and Description
BufferedIndexOutput()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes this stream to further operations.
void	flush() Forces any buffered output to be written.
protected abstract void	flushBuffer(byte[] b, int offset, int len) Expert: implements buffer write.
long	getFilePointer() Returns the current position in this file, where the next write will occur.
abstract long	length() The number of bytes in the file.
void	seek(long pos) Sets current position in this file, where the next write will occur.
void	writeByte(byte b) Writes a single byte.
void	writeBytes(byte[] b, int offset, int length) Writes an array of bytes.

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

setLength

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

copyBytes, writeBytes, writeChars, writeChars, writeInt, writeLong, writeShort, writeString, writeStringStringMap, writeVInt, writeVLong

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedIndexOutput

public BufferedIndexOutput()

Method Detail

writeByte

public void writeByte(byte b)
               throws java.io.IOException

Writes a single byte.

Specified by:

writeByte in class DataOutput

Throws:

java.io.IOException

See Also:

DataInput.readByte()

writeBytes

public void writeBytes(byte[] b,
              int offset,
              int length)
                throws java.io.IOException

Writes an array of bytes.

Specified by:

writeBytes in class DataOutput

Parameters:

b - the bytes to write

length - the number of bytes to write

offset - the offset in the byte array

Throws:

java.io.IOException

See Also:

DataInput.readBytes(byte[],int,int)

flush

public void flush()
           throws java.io.IOException

Forces any buffered output to be written.

Specified by:

flush in class IndexOutput

Throws:

java.io.IOException

flushBuffer

protected abstract void flushBuffer(byte[] b,
               int offset,
               int len)
                             throws java.io.IOException

Expert: implements buffer write. Writes bytes at the current position in the output.

Parameters:

b - the bytes to write

offset - the offset in the byte array

len - the number of bytes to write

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes this stream to further operations.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class IndexOutput

Throws:

java.io.IOException

getFilePointer

public long getFilePointer()

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

Specified by:

getFilePointer in class IndexOutput

See Also:

seek(long)

seek

public void seek(long pos)
          throws java.io.IOException

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

Specified by:

seek in class IndexOutput

Throws:

java.io.IOException

See Also:

getFilePointer()

length

public abstract long length()
                     throws java.io.IOException

The number of bytes in the file.

Specified by:

length in class IndexOutput

Throws:

java.io.IOException