ArrayKVWriter (JSimpleDB Array Key/Value Store 2.1.7 API)

java.lang.Object
- org.jsimpledb.kv.array.ArrayKVWriter

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class ArrayKVWriter
extends Object
implements Closeable
```
Writes ArrayKVStore index, key, and value data, given a sorted sequence of key/value pairs.
Key and value data must not exceed 2GB (each separately).

Constructor Summary

Constructors
Constructor and Description

ArrayKVWriter(OutputStream indxOutput, OutputStream keysOutput, OutputStream valsOutput)
Constructor.

Constructors
Constructor and Description
`ArrayKVWriter(OutputStream indxOutput, OutputStream keysOutput, OutputStream valsOutput)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close all three outputs.
`void`	`flush()` Flush all three outputs.
`int`	`getIndxLength()` Get the number of bytes written so far to the index file.
`int`	`getKeysLength()` Get the number of bytes written so far to the key data file.
`int`	`getValsLength()` Get the number of bytes written so far to the value data file.
`void`	`writeKV(byte[] key, byte[] val)` Write out the next key/value pair.
`void`	`writeMerged(KVStore kvstore, Iterator<KVPair> kvIterator, Mutations mutations)` Merge the given key/value pair iteration with the specified mutations and write out the merged combination.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArrayKVWriter
```
public ArrayKVWriter(OutputStream indxOutput,
             OutputStream keysOutput,
             OutputStream valsOutput)
```
    Constructor.
    
    Parameters:
    indxOutput - index file output
    keysOutput - key data file output
    valsOutput - value data file output
- Method Detail
  - getIndxLength
```
public int getIndxLength()
```
    Get the number of bytes written so far to the index file.
    
    Returns:
    length of the index file
  - getKeysLength
```
public int getKeysLength()
```
    Get the number of bytes written so far to the key data file.
    
    Returns:
    length of the key data file
  - getValsLength
```
public int getValsLength()
```
    Get the number of bytes written so far to the value data file.
    
    Returns:
    length of the value data file
  - writeKV
```
public void writeKV(byte[] key,
           byte[] val)
             throws IOException
```
    Write out the next key/value pair.
    
    Parameters:
    key - key
    val - value
    
    Throws:
    
    IllegalArgumentException - if key is out of order (i.e., not strictly greater then the previous key)
    
    IllegalArgumentException - if key or val is null
    
    IllegalStateException - if either the key or data file would grow larger than 2³¹-1 bytes
    
    IOException - if an I/O error occurrs
  - writeMerged
```
public void writeMerged(KVStore kvstore,
               Iterator<KVPair> kvIterator,
               Mutations mutations)
                 throws IOException
```
    Merge the given key/value pair iteration with the specified mutations and write out the merged combination. What's written is the result of the key/value iteration with the mutations applied.
    The KVStore parameter will only be used to invoke KVStore.encodeCounter() and KVStore.decodeCounter() in order to handle counter adjustments.
    
    Parameters:
    kvstore - callback for encoding and decoding counter values
    kvIterator - key/value pairs - must be sorted in order
    mutations - mutations to apply
    
    Throws:
    
    IllegalArgumentException - if any parameter is null
    
    IllegalArgumentException - if kvs iterates out of order
    
    IllegalStateException - if either the key or data file would grow larger than 2³¹-1 bytes
    
    IOException - if an I/O error occurrs
  - flush
```
public void flush()
           throws IOException
```
    Flush all three outputs.
    
    Throws:
    
    IOException - if an I/O error occurrs
  - close
```
public void close()
           throws IOException
```
    Close all three outputs.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - if an I/O error occurrs

Class ArrayKVWriter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArrayKVWriter

Method Detail

getIndxLength

getKeysLength

getValsLength

writeKV

writeMerged

flush

close