Package io.permazen.kv.simple

Class SimpleKVImplementation

java.lang.Object

io.permazen.kv.simple.SimpleKVImplementation

All Implemented Interfaces:

KVImplementation<SimpleKVImplementation.Config>

public class SimpleKVImplementation
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleKVImplementation.Config

Constructor Summary

Constructors

Constructor	Description
SimpleKVImplementation()

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, SimpleKVImplementation.Config config)
SimpleKVImplementation.Config	buildConfig(joptsimple.OptionSet options)	Build a configuration from implementation-specific command line options, if any were given.
KVDatabase	createKVDatabase(SimpleKVImplementation.Config config, KVDatabase kvdb, AtomicKVStore kvstore)	Create an KVDatabase using the specified configuration.
String	getDescription(SimpleKVImplementation.Config config)	Generate a short, human-readable description of the KVDatabase instance configured as given.
boolean	providesKVDatabase(SimpleKVImplementation.Config config)	Determine whether this KVImplementation includes an implementation of the KVDatabase interface.
boolean	requiresAtomicKVStore(SimpleKVImplementation.Config config)	Determine whether this instance's KVDatabase implementation requires an underlying AtomicKVStore.

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

createAtomicKVStore, getConfigType, providesAtomicKVStore, requiresKVDatabase

Constructor Details

SimpleKVImplementation

public SimpleKVImplementation()

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 SimpleKVImplementation.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(SimpleKVImplementation.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

createKVDatabase

public KVDatabase createKVDatabase(SimpleKVImplementation.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

requiresAtomicKVStore

public boolean requiresAtomicKVStore(SimpleKVImplementation.Config config)

Description copied from interface: KVImplementation

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

getDescription

public String getDescription(SimpleKVImplementation.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,
 SimpleKVImplementation.Config config)