BufferedIndexOutput (Lucene 2.9.4 API)

java.lang.Object
- org.apache.lucene.store.IndexOutput
- - org.apache.lucene.store.BufferedIndexOutput

Direct Known Subclasses:

SimpleFSDirectory.SimpleFSIndexOutput
```
public abstract class BufferedIndexOutput
extends IndexOutput
```
Base implementation class for buffered IndexOutput.

Constructor Summary

Constructors
Constructor and Description

BufferedIndexOutput()

Constructors
Constructor and Description
`BufferedIndexOutput()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete 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
copyBytes, setLength, writeBytes, writeChars, writeChars, writeInt, writeLong, 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 IndexOutput
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    IndexInput.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 IndexOutput
    
    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:
    
    IndexInput.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 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

Class BufferedIndexOutput

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

BufferedIndexOutput

Method Detail

writeByte

writeBytes

flush

flushBuffer

close

getFilePointer

seek

length