io.permazen.kv.leveldb

Class LevelDBKVImplementation

java.lang.Object

io.permazen.kv.KVImplementation<File>

io.permazen.kv.leveldb.LevelDBKVImplementation

public class LevelDBKVImplementation
extends KVImplementation<File>

Field Summary

Fields inherited from class io.permazen.kv.KVImplementation

log, XML_DESCRIPTOR_RESOURCE

Constructor Summary

Constructors

Constructor and Description
LevelDBKVImplementation()

Method Summary

Modifier and Type	Method and Description
LevelDBAtomicKVStore	createAtomicKVStore(File directory) Create an AtomicKVStore using the specified configuration.
LevelDBKVDatabase	createKVDatabase(File directory, KVDatabase kvdb, AtomicKVStore kvstore) Create an KVDatabase using the specified configuration.
String[][]	getCommandLineOptions() Get the command line options supported by this implementation, suitable for display in a usage help message.
String	getDescription(File directory) Generate a short, human-readable description of the KVDatabase instance configured as given.
File	parseCommandLineOptions(ArrayDeque<String> options) Parse the specified command line options and return the resulting configuration, if possible.

Methods inherited from class io.permazen.kv.KVImplementation

getConfigType, getImplementations, getUsageText, parseCommandLineFlag, parseCommandLineOption, requiresAtomicKVStore, requiresKVDatabase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LevelDBKVImplementation

public LevelDBKVImplementation()

Method Detail

getCommandLineOptions

public String[][] getCommandLineOptions()

Description copied from class: KVImplementation

Get the command line options supported by this implementation, suitable for display in a usage help message.

There must be at least one option, to indicate that this implementation is to be used.

Specified by:

getCommandLineOptions in class KVImplementation<File>

Returns:

array of pairs: { option, description }

parseCommandLineOptions

public File parseCommandLineOptions(ArrayDeque<String> options)

Description copied from class: KVImplementation

Parse the specified command line options and return the resulting configuration, if possible.

At least one option must be recognized, indicating that this implementation is to be used, otherwise null should be returned.

Specified by:

parseCommandLineOptions in class KVImplementation<File>

Parameters:

options - all command line options; upon return, recognized options should be removed

Returns:

configuration object representing the parsed options, or null if this implementation is not specified/configured

createKVDatabase

public LevelDBKVDatabase createKVDatabase(File directory,
                                          KVDatabase kvdb,
                                          AtomicKVStore kvstore)

Description copied from class: KVImplementation

Create an KVDatabase using the specified configuration.

Specified by:

createKVDatabase in class KVImplementation<File>

Parameters:

directory - implementation configuration returned by parseCommandLineOptions()

kvdb - required KVDatabase; will be null unless KVImplementation.requiresKVDatabase(C) returned true

kvstore - required AtomicKVStore; will be null unless KVImplementation.requiresAtomicKVStore(C) returned true

Returns:

new KVDatabase instance

createAtomicKVStore

public LevelDBAtomicKVStore createAtomicKVStore(File directory)

Description copied from class: KVImplementation

Create an AtomicKVStore using the specified configuration.

The implementation in KVImplementation invokes createKVDatabase() and constructs a AtomicKVDatabase from the result. Implementations that natively support the AtomicKVDatabase interface should override this method.

Overrides:

createAtomicKVStore in class KVImplementation<File>

Parameters:

directory - implementation configuration returned by parseCommandLineOptions()

Returns:

new AtomicKVStore instance

getDescription

public String getDescription(File directory)

Description copied from class: KVImplementation

Generate a short, human-readable description of the KVDatabase instance configured as given.

Specified by:

getDescription in class KVImplementation<File>

Parameters:

directory - implementation configuration returned by parseCommandLineOptions()

Returns:

human-readable description