RAMOutputStream (Lucene 2.9.4 API)

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

```
public class RAMOutputStream
extends IndexOutput
```
A memory-resident IndexOutput implementation.
For Lucene internal use

Version:

$Id: RAMOutputStream.java 941125 2010-05-05 00:44:15Z mikemccand $

Constructor Summary

Constructors
Constructor and Description

RAMOutputStream()
Construct an empty output buffer.

RAMOutputStream(RAMFile f)

Constructors
Constructor and Description
`RAMOutputStream()` Construct an empty output buffer.
`RAMOutputStream(RAMFile f)`

Method Summary

All Methods Instance 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.
`long`	`getFilePointer()` Returns the current position in this file, where the next write will occur.
`long`	`length()` The number of bytes in the file.
`void`	`reset()` Resets this to an empty file.
`void`	`seek(long pos)` Sets current position in this file, where the next write will occur.
`long`	`sizeInBytes()` Returns byte usage of all buffers.
`void`	`writeByte(byte b)` Writes a single byte.
`void`	`writeBytes(byte[] b, int offset, int len)` Writes an array of bytes.
`void`	`writeTo(IndexOutput out)` Copy the current contents of this buffer to the named output.

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
  - RAMOutputStream
```
public RAMOutputStream()
```
    Construct an empty output buffer.
  - RAMOutputStream
```
public RAMOutputStream(RAMFile f)
```
- Method Detail
  - writeTo
```
public void writeTo(IndexOutput out)
             throws java.io.IOException
```
    Copy the current contents of this buffer to the named output.
    
    Throws:
    
    java.io.IOException
  - reset
```
public void reset()
```
    Resets this to an empty file.
  - close
```
public void close()
           throws java.io.IOException
```
    Description copied from class: IndexOutput
    
    Closes this stream to further operations.
    
    Specified by:
    
    close in class IndexOutput
    
    Throws:
    
    java.io.IOException
  - seek
```
public void seek(long pos)
          throws java.io.IOException
```
    Description copied from class: IndexOutput
    
    Sets current position in this file, where the next write will occur.
    
    Specified by:
    
    seek in class IndexOutput
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    IndexOutput.getFilePointer()
  - length
```
public long length()
```
    Description copied from class: IndexOutput
    
    The number of bytes in the file.
    
    Specified by:
    
    length in class IndexOutput
  - writeByte
```
public void writeByte(byte b)
               throws java.io.IOException
```
    Description copied from class: IndexOutput
    
    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 len)
                throws java.io.IOException
```
    Description copied from class: IndexOutput
    
    Writes an array of bytes.
    
    Specified by:
    
    writeBytes in class IndexOutput
    
    Parameters:
    
    b - the bytes to write
    
    offset - the offset in the byte array
    
    len - the number of bytes to write
    
    Throws:
    
    java.io.IOException
    
    See Also:
    
    IndexInput.readBytes(byte[],int,int)
  - flush
```
public void flush()
           throws java.io.IOException
```
    Description copied from class: IndexOutput
    
    Forces any buffered output to be written.
    
    Specified by:
    
    flush in class IndexOutput
    
    Throws:
    
    java.io.IOException
  - getFilePointer
```
public long getFilePointer()
```
    Description copied from class: IndexOutput
    
    Returns the current position in this file, where the next write will occur.
    
    Specified by:
    
    getFilePointer in class IndexOutput
    
    See Also:
    
    IndexOutput.seek(long)
  - sizeInBytes
```
public long sizeInBytes()
```
    Returns byte usage of all buffers.

Class RAMOutputStream

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

RAMOutputStream

RAMOutputStream

Method Detail

writeTo

reset

close

seek

length

writeByte

writeBytes

flush

getFilePointer

sizeInBytes