Package io.permazen.kv.mvstore

Class MVStoreKVImplementation

java.lang.Object

io.permazen.kv.mvstore.MVStoreKVImplementation

All Implemented Interfaces:

KVImplementation<MVStoreKVImplementation.Config>

public class MVStoreKVImplementation
extends Object
implements KVImplementation<MVStoreKVImplementation.Config>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MVStoreKVImplementation.Config

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MAP_NAME	Default MVStore map name to use ("Permazen").

Constructor Summary

Constructors

Constructor	Description
MVStoreKVImplementation()

Method Summary

Modifier and Type	Method	Description
void	addOptions(joptsimple.OptionParser parser)	Add implementation-specific command line options.
MVStoreKVImplementation.Config	buildConfig(joptsimple.OptionSet options)	Build a configuration from implementation-specific command line options, if any were given.
MVStoreAtomicKVStore	createAtomicKVStore(MVStoreKVImplementation.Config config)	Create an AtomicKVStore using the specified configuration.
MVStoreKVDatabase	createKVDatabase(MVStoreKVImplementation.Config config, KVDatabase ignored1, AtomicKVStore ignored2)	Create an KVDatabase using the specified configuration.
String	getDescription(MVStoreKVImplementation.Config config)	Generate a short, human-readable description of the KVDatabase instance configured as given.
boolean	providesAtomicKVStore(MVStoreKVImplementation.Config config)	Determine whether this KVImplementation includes an implementation of the AtomicKVStore interface.
boolean	providesKVDatabase(MVStoreKVImplementation.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

Field Details

DEFAULT_MAP_NAME

public static final String DEFAULT_MAP_NAME

Default MVStore map name to use ("Permazen").

See Also:

• Constant Field Values

Constructor Details

MVStoreKVImplementation

public MVStoreKVImplementation()

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.

Specified by:

addOptions in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

parser - command line flag parser

buildConfig

public MVStoreKVImplementation.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.

Specified by:

buildConfig in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

options - parsed command line options

Returns:

corresponding configuration, or null if this implementation was not configured

providesKVDatabase

public boolean providesKVDatabase(MVStoreKVImplementation.Config config)

Description copied from interface: KVImplementation

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

The implementation in KVImplementation return false.

Specified by:

providesKVDatabase in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an KVDatabase

providesAtomicKVStore

public boolean providesAtomicKVStore(MVStoreKVImplementation.Config config)

Description copied from interface: KVImplementation

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

The implementation in KVImplementation return false.

Specified by:

providesAtomicKVStore in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an AtomicKVStore

createKVDatabase

public MVStoreKVDatabase createKVDatabase(MVStoreKVImplementation.Config config,
 KVDatabase ignored1,
 AtomicKVStore ignored2)

Description copied from interface: KVImplementation

Create an KVDatabase using the specified configuration.

The implementation in KVImplementation always throws UnsupportedOperationException.

Specified by:

createKVDatabase in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

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

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

Returns:

new KVDatabase instance

createAtomicKVStore

public MVStoreAtomicKVStore createAtomicKVStore(MVStoreKVImplementation.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.

Specified by:

createAtomicKVStore in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

new AtomicKVStore instance

getDescription

public String getDescription(MVStoreKVImplementation.Config config)

Description copied from interface: KVImplementation

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

Specified by:

getDescription in interface KVImplementation<MVStoreKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

human-readable description