io.permazen.kv.simple

Class MemoryKVImplementation

java.lang.Object

io.permazen.kv.KVImplementation<Boolean>

io.permazen.kv.simple.MemoryKVImplementation

public class MemoryKVImplementation
extends KVImplementation<Boolean>

Field Summary

Fields inherited from class io.permazen.kv.KVImplementation

log, XML_DESCRIPTOR_RESOURCE

Constructor Summary

Constructors

Constructor and Description
MemoryKVImplementation()

Method Summary

Modifier and Type	Method and Description
SimpleKVDatabase	createKVDatabase(Boolean config, 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(Boolean config) Generate a short, human-readable description of the KVDatabase instance configured as given.
Boolean	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

createAtomicKVStore, 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

MemoryKVImplementation

public MemoryKVImplementation()

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<Boolean>

Returns:

array of pairs: { option, description }

parseCommandLineOptions

public Boolean 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<Boolean>

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 SimpleKVDatabase createKVDatabase(Boolean config,
                                         KVDatabase kvdb,
                                         AtomicKVStore kvstore)

Description copied from class: KVImplementation

Create an KVDatabase using the specified configuration.

Specified by:

createKVDatabase in class KVImplementation<Boolean>

Parameters:

config - 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

getDescription

public String getDescription(Boolean config)

Description copied from class: KVImplementation

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

Specified by:

getDescription in class KVImplementation<Boolean>

Parameters:

config - implementation configuration returned by parseCommandLineOptions()

Returns:

human-readable description