Package io.permazen.kv.raft

Class RaftKVImplementation

java.lang.Object

io.permazen.kv.raft.RaftKVImplementation

All Implemented Interfaces:

KVImplementation<RaftKVImplementation.Config>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RaftKVImplementation.Config

Constructor Summary

Constructors

Constructor	Description
RaftKVImplementation()

Method Summary

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

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

Constructor Details

RaftKVImplementation

public RaftKVImplementation()

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<RaftKVImplementation.Config>

Parameters:

parser - command line flag parser

buildConfig

public RaftKVImplementation.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<RaftKVImplementation.Config>

Parameters:

options - parsed command line options

Returns:

corresponding configuration, or null if this implementation was not configured

providesKVDatabase

public boolean providesKVDatabase(RaftKVImplementation.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<RaftKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if this instance can create an KVDatabase

createKVDatabase

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

Specified by:

createKVDatabase in interface KVImplementation<RaftKVImplementation.Config>

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

Specified by:

requiresAtomicKVStore in interface KVImplementation<RaftKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if the implementation relies on an underlying AtomicKVStore

requiresKVDatabase

public boolean requiresKVDatabase(RaftKVImplementation.Config config)

Description copied from interface: KVImplementation

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.

Specified by:

requiresKVDatabase in interface KVImplementation<RaftKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

true if the implementation relies on an underlying KVDatabase

getDescription

public String getDescription(RaftKVImplementation.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<RaftKVImplementation.Config>

Parameters:

config - implementation configuration returned by buildConfig()

Returns:

human-readable description