org.apache.lucene.store
Class OpenBufferedIndexOutput

java.lang.Object
  org.apache.lucene.store.DataOutput
      org.apache.lucene.store.IndexOutput
          org.apache.lucene.store.OpenBufferedIndexOutput

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

BufferedChecksumIndexOutput

public abstract class OpenBufferedIndexOutput
extends org.apache.lucene.store.IndexOutput

Exactly the same as Lucene BufferedIndexOutput but with the ability to set the buffer size

Field Summary

static int

DEFAULT_BUFFER_SIZE

Constructor Summary

protected

OpenBufferedIndexOutput(int BUFFER_SIZE)

Method Summary

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

OpenBufferedIndexOutput

protected OpenBufferedIndexOutput(int BUFFER_SIZE)

Method Detail

writeByte

public void writeByte(byte b)
               throws IOException

Writes a single byte.

Specified by:

writeByte in class org.apache.lucene.store.DataOutput

Throws:

IOException

See Also:

DataInput.readByte()

writeBytes

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

Writes an array of bytes.

Specified by:

writeBytes in class org.apache.lucene.store.DataOutput

Parameters:

b - the bytes to write

length - the number of bytes to write

Throws:

IOException

See Also:

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

flush

public void flush()
           throws IOException

Forces any buffered output to be written.

Specified by:

flush in class org.apache.lucene.store.IndexOutput

Throws:

IOException

flushBuffer

protected abstract void flushBuffer(byte[] b,
                                    int offset,
                                    int len)
                             throws 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:

IOException

close

public void close()
           throws IOException

Closes this stream to further operations.

Specified by:

close in interface Closeable

Specified by:

close in class org.apache.lucene.store.IndexOutput

Throws:

IOException

getFilePointer

public long getFilePointer()

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

Specified by:

getFilePointer in class org.apache.lucene.store.IndexOutput

See Also:

seek(long)

seek

public void seek(long pos)
          throws IOException

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

Specified by:

seek in class org.apache.lucene.store.IndexOutput

Throws:

IOException

See Also:

getFilePointer()

length

public abstract long length()
                     throws IOException

The number of bytes in the file.

Specified by:

length in class org.apache.lucene.store.IndexOutput

Throws:

IOException