LevelDBAtomicKVStore (JSimpleDB LevelDB Key/Value Store 2.1.2 API)

java.lang.Object
- org.jsimpledb.kv.util.ForwardingKVStore
- - org.jsimpledb.kv.leveldb.LevelDBAtomicKVStore

All Implemented Interfaces:

KVStore, AtomicKVStore
```
public class LevelDBAtomicKVStore
extends ForwardingKVStore
implements AtomicKVStore
```
An AtomicKVStore view of a LevelDB database.
A database directory is the only required configuration property. Instances may be stopped and (re)started multiple times.

Constructor Summary

Constructors
Constructor and Description

LevelDBAtomicKVStore()
Constructor.

LevelDBAtomicKVStore(org.iq80.leveldb.DBFactory factory)
Constructor.

Constructors
Constructor and Description
`LevelDBAtomicKVStore()` Constructor.
`LevelDBAtomicKVStore(org.iq80.leveldb.DBFactory factory)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected LevelDBKVStore`	`delegate()`
`protected void`	`finalize()` Finalize this instance.
`org.iq80.leveldb.DB`	`getDB()` Get the underlying `DB` associated with this instance.
`File`	`getDirectory()` Get the filesystem directory containing the database.
`org.iq80.leveldb.Options`	`getOptions()` Get the `Options` this instance will use when opening the database at startup.
`void`	`mutate(Mutations mutations, boolean sync)`
`void`	`setBlockRestartInterval(int blockRestartInterval)` Configure the number of keys between restart points for delta encoding of keys.
`void`	`setBlockSize(int blockSize)` Configure the block size.
`void`	`setCacheSize(long cacheSize)` Configure the cache size.
`void`	`setCompressionType(org.iq80.leveldb.CompressionType compressionType)` Configure the compression type.
`void`	`setCreateIfMissing(boolean createIfMissing)` Configure whether to create the database if missing.
`void`	`setDirectory(File directory)` Configure the filesystem directory containing the database.
`void`	`setErrorIfExists(boolean errorIfExists)` Configure whether to throw an error if the database already exists.
`void`	`setMaxOpenFiles(int maxOpenFiles)` Configure the maximum number of open files.
`void`	`setOptions(org.iq80.leveldb.Options options)` Set the `Options` this instance will use when opening the database at startup.
`void`	`setParanoidChecks(boolean paranoidChecks)` Configure whether paranoid checks are enabled.
`void`	`setVerifyChecksums(boolean verifyChecksums)` Configure whether to verify checksums.
`void`	`setWriteBufferSize(int writeBufferSize)` Configure the write buffer size.
`SnapshotLevelDBKVStore`	`snapshot()`
`void`	`start()`
`void`	`stop()`
`String`	`toString()`

Methods inherited from class org.jsimpledb.kv.util.ForwardingKVStore
adjustCounter, decodeCounter, encodeCounter, get, getAtLeast, getAtMost, getRange, put, remove, removeRange

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

Methods inherited from interface org.jsimpledb.kv.KVStore
adjustCounter, decodeCounter, encodeCounter, get, getAtLeast, getAtMost, getRange, put, remove, removeRange

- Constructor Detail
  - LevelDBAtomicKVStore
```
public LevelDBAtomicKVStore()
```
    Constructor.
    Uses the default DBFactory provided by LevelDBUtil.getDefaultDBFactory().
  - LevelDBAtomicKVStore
```
public LevelDBAtomicKVStore(org.iq80.leveldb.DBFactory factory)
```
    Constructor.
    
    Parameters:
    factory - factory for database
    
    Throws:
    
    IllegalArgumentException - if factory is null
- Method Detail
  - getDirectory
```
public File getDirectory()
```
    Get the filesystem directory containing the database.
    
    Returns:
    database directory
  - setDirectory
```
public void setDirectory(File directory)
```
    Configure the filesystem directory containing the database. Required property.
    
    Parameters:
    directory - database directory
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - getDB
```
public org.iq80.leveldb.DB getDB()
```
    Get the underlying DB associated with this instance.
    
    Returns:
    the associated DB
    
    Throws:
    
    IllegalStateException - if this instance is not start()ed
  - getOptions
```
public org.iq80.leveldb.Options getOptions()
```
    Get the Options this instance will use when opening the database at startup.
    
    Returns:
    database options
  - setOptions
```
public void setOptions(org.iq80.leveldb.Options options)
```
    Set the Options this instance will use when opening the database at startup. Overwrites any previous options configuration(s).
    
    Parameters:
    options - database options
    
    Throws:
    
    IllegalArgumentException - if options is null
    
    IllegalStateException - if this instance is already start()ed
  - setBlockRestartInterval
```
public void setBlockRestartInterval(int blockRestartInterval)
```
    Configure the number of keys between restart points for delta encoding of keys. Default 16.
    
    Parameters:
    blockRestartInterval - restart interval
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setBlockSize
```
public void setBlockSize(int blockSize)
```
    Configure the block size. Default 4K.
    
    Parameters:
    blockSize - block size
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setCacheSize
```
public void setCacheSize(long cacheSize)
```
    Configure the cache size. Default 8MB.
    
    Parameters:
    cacheSize - cache size
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setCompressionType
```
public void setCompressionType(org.iq80.leveldb.CompressionType compressionType)
```
    Configure the compression type. Default CompressionType.SNAPPY.
    
    Parameters:
    compressionType - compression type.
    
    Throws:
    
    IllegalArgumentException - if compressionType is null
    
    IllegalStateException - if this instance is already start()ed
  - setCreateIfMissing
```
public void setCreateIfMissing(boolean createIfMissing)
```
    Configure whether to create the database if missing. Default true.
    
    Parameters:
    createIfMissing - true to create if missing
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setErrorIfExists
```
public void setErrorIfExists(boolean errorIfExists)
```
    Configure whether to throw an error if the database already exists. Default false.
    
    Parameters:
    errorIfExists - true for error if database exists
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setMaxOpenFiles
```
public void setMaxOpenFiles(int maxOpenFiles)
```
    Configure the maximum number of open files. Default 1000.
    
    Parameters:
    maxOpenFiles - maximum number of open files
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setParanoidChecks
```
public void setParanoidChecks(boolean paranoidChecks)
```
    Configure whether paranoid checks are enabled. Default false.
    
    Parameters:
    paranoidChecks - true to enable
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setVerifyChecksums
```
public void setVerifyChecksums(boolean verifyChecksums)
```
    Configure whether to verify checksums. Default true.
    
    Parameters:
    verifyChecksums - true to enable
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - setWriteBufferSize
```
public void setWriteBufferSize(int writeBufferSize)
```
    Configure the write buffer size. Default 4MB.
    
    Parameters:
    writeBufferSize - write buffer size
    
    Throws:
    
    IllegalStateException - if this instance is already start()ed
  - start
```
@PostConstruct
public void start()
```
    Specified by:
    
    start in interface AtomicKVStore
  - stop
```
@PreDestroy
public void stop()
```
    Specified by:
    
    stop in interface AtomicKVStore
  - delegate
```
protected LevelDBKVStore delegate()
```
    Specified by:
    
    delegate in class ForwardingKVStore
  - snapshot
```
public SnapshotLevelDBKVStore snapshot()
```
    Specified by:
    
    snapshot in interface AtomicKVStore
  - mutate
```
public void mutate(Mutations mutations,
          boolean sync)
```
    Specified by:
    
    mutate in interface AtomicKVStore
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Finalize this instance. Invokes stop() to close any unclosed iterators.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LevelDBAtomicKVStore

Constructor Summary

Method Summary

Methods inherited from class org.jsimpledb.kv.util.ForwardingKVStore

Methods inherited from class java.lang.Object

Methods inherited from interface org.jsimpledb.kv.KVStore

Constructor Detail

LevelDBAtomicKVStore

LevelDBAtomicKVStore

Method Detail

getDirectory

setDirectory

getDB

getOptions

setOptions

setBlockRestartInterval

setBlockSize

setCacheSize

setCompressionType

setCreateIfMissing

setErrorIfExists

setMaxOpenFiles

setParanoidChecks

setVerifyChecksums

setWriteBufferSize

start

stop

delegate

snapshot

mutate

finalize

toString