Package io.permazen.kv

Interface KVImplementation<C>

Type Parameters:

C - configuration object type

All Known Implementing Classes:

ArrayKVImplementation, BerkeleyKVImplementation, CockroachKVImplementation, FoundationKVImplementation, LevelDBKVImplementation, LMDBKVImplementation, MemoryKVImplementation, MSSQLKVImplementation, MVStoreKVImplementation, MySQLKVImplementation, RaftKVImplementation, SimpleKVImplementation, SpannerKVImplementation, SQLDriverKVImplementation, SQLiteKVImplementation, XMLKVImplementation, XodusKVImplementation

public interface KVImplementation<C>

Descriptor for a provider of KVDatabase and/or AtomicKVStore implementations.

Instances of this class provide information about how to configure and instantiate some technology-specific implementation of the KVDatabase and/or AtomicKVStore interfaces.

Method Summary

Modifier and Type	Method	Description
void	addOptions(joptsimple.OptionParser parser)	Add implementation-specific command line options.
C	buildConfig(joptsimple.OptionSet options)	Build a configuration from implementation-specific command line options, if any were given.
default AtomicKVStore	createAtomicKVStore(C config)	Create an AtomicKVStore using the specified configuration.
default KVDatabase	createKVDatabase(C config, KVDatabase kvdb, AtomicKVStore kvstore)	Create an KVDatabase using the specified configuration.
default Class<C>	getConfigType()	Get the configuration object type for this instance.
String	getDescription(C config)	Generate a short, human-readable description of the KVDatabase instance configured as given.
default boolean	providesAtomicKVStore(C config)	Determine whether this KVImplementation includes an implementation of the AtomicKVStore interface.
default boolean	providesKVDatabase(C config)	Determine whether this KVImplementation includes an implementation of the KVDatabase interface.
default boolean	requiresAtomicKVStore(C config)	Determine whether this instance's KVDatabase implementation requires an underlying AtomicKVStore.
default boolean	requiresKVDatabase(C config)	Determine whether this instance's KVDatabase implementation requires some other underlying KVDatabase.

Method Details

getConfigType

default Class<C> getConfigType()

Get the configuration object type for this instance.

Returns:

config type

addOptions

void addOptions(joptsimple.OptionParser parser)

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

Throws:

IllegalArgumentException - if parser is null

buildConfig

C buildConfig(joptsimple.OptionSet options)

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

Throws:

joptsimple.OptionException - if invalid options were given

IllegalArgumentException - if invalid options were given

IllegalArgumentException - if options is null

providesAtomicKVStore

default boolean providesAtomicKVStore(C config)

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

Throws:

IllegalArgumentException - if config is null

providesKVDatabase

default boolean providesKVDatabase(C config)

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

Throws:

IllegalArgumentException - if config is null

createKVDatabase

default KVDatabase createKVDatabase(C config,
 KVDatabase kvdb,
 AtomicKVStore kvstore)

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 requiresKVDatabase(C) returned true

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

Returns:

new KVDatabase instance

Throws:

UnsupportedOperationException - if providesKVDatabase(C) returns false

IllegalArgumentException - if config is null

createAtomicKVStore

default AtomicKVStore createAtomicKVStore(C config)

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

Throws:

IllegalArgumentException - if config is null

requiresAtomicKVStore

default boolean requiresAtomicKVStore(C config)

Determine whether this instance's KVDatabase implementation requires an underlying AtomicKVStore.

This method and requiresKVDatabase() may not both return true.

The implementation in KVImplementation return false.

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if the implementation relies on an underlying AtomicKVStore

Throws:

IllegalArgumentException - if config is null

requiresKVDatabase

default boolean requiresKVDatabase(C config)

Determine whether this instance's KVDatabase implementation requires some other underlying KVDatabase.

This method and requiresAtomicKVStore() may not both return true.

The implementation in KVImplementation return false.

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if the implementation relies on an underlying KVDatabase

Throws:

IllegalArgumentException - if config is null

getDescription

String getDescription(C config)

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

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

human-readable description