Package io.permazen.kv.array

Class ArrayKVImplementation

java.lang.Object

io.permazen.kv.array.ArrayKVImplementation

All Implemented Interfaces:

KVImplementation<File>

public class ArrayKVImplementation
extends Object
implements KVImplementation<File>

Constructor Summary

Constructors

Constructor	Description
ArrayKVImplementation()

Method Summary

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

ArrayKVImplementation

public ArrayKVImplementation()

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

Parameters:

parser - command line flag parser

buildConfig

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

Parameters:

options - parsed command line options

Returns:

corresponding configuration, or null if this implementation was not configured

providesKVDatabase

public boolean providesKVDatabase(File 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<File>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an KVDatabase

providesAtomicKVStore

public boolean providesAtomicKVStore(File 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<File>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an AtomicKVStore

createKVDatabase

public ArrayKVDatabase createKVDatabase(File directory,
 KVDatabase kvdb,
 AtomicKVStore kvstore)

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

Parameters:

directory - 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 AtomicArrayKVStore createAtomicKVStore(File directory)

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

Parameters:

directory - implementation configuration returned by buildConfig()

Returns:

new AtomicKVStore instance

getDescription

public String getDescription(File directory)

Description copied from interface: KVImplementation

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

Specified by:

getDescription in interface KVImplementation<File>

Parameters:

directory - implementation configuration returned by buildConfig()

Returns:

human-readable description