Package io.permazen.kv.simple

Class MemoryKVImplementation

java.lang.Object

io.permazen.kv.simple.MemoryKVImplementation

All Implemented Interfaces:

KVImplementation<MemoryKVImplementation.Config>

public class MemoryKVImplementation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MemoryKVImplementation.Config

Constructor Summary

Constructors

Constructor	Description
MemoryKVImplementation()

Method Summary

Modifier and Type	Method	Description
void	addOptions(joptsimple.OptionParser parser)	Add implementation-specific command line options.
protected void	addSimpleOptions(joptsimple.OptionParser parser, joptsimple.OptionSpec<?> enablingOption, String prefix)
protected void	applySimpleOptions(joptsimple.OptionSet options, MemoryKVImplementation.Config config)
MemoryKVImplementation.Config	buildConfig(joptsimple.OptionSet options)	Build a configuration from implementation-specific command line options, if any were given.
MemoryAtomicKVStore	createAtomicKVStore(MemoryKVImplementation.Config config)	Create an AtomicKVStore using the specified configuration.
MemoryKVDatabase	createKVDatabase(MemoryKVImplementation.Config config, KVDatabase kvdb, AtomicKVStore kvstore)	Create an KVDatabase using the specified configuration.
String	getDescription(MemoryKVImplementation.Config config)	Generate a short, human-readable description of the KVDatabase instance configured as given.
boolean	providesAtomicKVStore(MemoryKVImplementation.Config config)	Determine whether this KVImplementation includes an implementation of the AtomicKVStore interface.
boolean	providesKVDatabase(MemoryKVImplementation.Config config)	Determine whether this KVImplementation includes an implementation of the KVDatabase interface.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.permazen.kv.KVImplementation

getConfigType, requiresAtomicKVStore, requiresKVDatabase

Constructor Details

MemoryKVImplementation

public MemoryKVImplementation()

Method Details

addOptions

public void addOptions(joptsimple.OptionParser parser)

Description copied from interface: KVImplementation

Add implementation-specific command line options.

All of the added options must be optional, because multiple key/value implementations will be available when the command line is parsed, and the presence of implementation-specific options determines which one(s) are chosen.

Parameters:

parser - command line flag parser

buildConfig

public MemoryKVImplementation.Config buildConfig(joptsimple.OptionSet options)

Description copied from interface: KVImplementation

Build a configuration from implementation-specific command line options, if any were given.

If none of this implementation's options were provided, then this method must return null.

Parameters:

options - parsed command line options

Returns:

corresponding configuration, or null if this implementation was not configured

providesKVDatabase

public boolean providesKVDatabase(MemoryKVImplementation.Config config)

Description copied from interface: KVImplementation

Determine whether this KVImplementation includes an implementation of the KVDatabase interface.

The implementation in KVImplementation return false.

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an KVDatabase

providesAtomicKVStore

public boolean providesAtomicKVStore(MemoryKVImplementation.Config config)

Description copied from interface: KVImplementation

Determine whether this KVImplementation includes an implementation of the AtomicKVStore interface.

The implementation in KVImplementation return false.

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an AtomicKVStore

createKVDatabase

public MemoryKVDatabase createKVDatabase(MemoryKVImplementation.Config config,
 KVDatabase kvdb,
 AtomicKVStore kvstore)

Description copied from interface: KVImplementation

Create an KVDatabase using the specified configuration.

The implementation in KVImplementation always throws UnsupportedOperationException.

Parameters:

config - implementation configuration returned by buildConfig()

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 MemoryAtomicKVStore createAtomicKVStore(MemoryKVImplementation.Config config)

Description copied from interface: KVImplementation

Create an AtomicKVStore using the specified configuration.

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

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

new AtomicKVStore instance

getDescription

public String getDescription(MemoryKVImplementation.Config config)

Description copied from interface: KVImplementation

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

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

human-readable description

addSimpleOptions

protected void addSimpleOptions(joptsimple.OptionParser parser,
 joptsimple.OptionSpec<?> enablingOption,
 String prefix)

applySimpleOptions

protected void applySimpleOptions(joptsimple.OptionSet options,
 MemoryKVImplementation.Config config)