io.permazen.kv.xodus

Class XodusKVImplementation

java.lang.Object

io.permazen.kv.KVImplementation<XodusKVImplementation.Config>

io.permazen.kv.xodus.XodusKVImplementation

public class XodusKVImplementation
extends KVImplementation<XodusKVImplementation.Config>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XodusKVImplementation.Config

Field Summary

Fields inherited from class io.permazen.kv.KVImplementation

log, XML_DESCRIPTOR_RESOURCE

Constructor Summary

Constructors

Constructor and Description
XodusKVImplementation()

Method Summary

Modifier and Type	Method and Description
XodusKVDatabase	createKVDatabase(XodusKVImplementation.Config config, KVDatabase ignored, AtomicKVStore kvstore) Create an KVDatabase using the specified configuration.
String[][]	getCommandLineOptions() Get the command line options supported by this implementation, suitable for display in a usage help message.
String	getDescription(XodusKVImplementation.Config config) Generate a short, human-readable description of the KVDatabase instance configured as given.
XodusKVImplementation.Config	parseCommandLineOptions(ArrayDeque<String> options) Parse the specified command line options and return the resulting configuration, if possible.

Methods inherited from class io.permazen.kv.KVImplementation

createAtomicKVStore, getConfigType, getImplementations, getUsageText, parseCommandLineFlag, parseCommandLineOption, requiresAtomicKVStore, requiresKVDatabase

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XodusKVImplementation

public XodusKVImplementation()

Method Detail

getCommandLineOptions

public String[][] getCommandLineOptions()

Description copied from class: KVImplementation

Get the command line options supported by this implementation, suitable for display in a usage help message.

There must be at least one option, to indicate that this implementation is to be used.

Specified by:

getCommandLineOptions in class KVImplementation<XodusKVImplementation.Config>

Returns:

array of pairs: { option, description }

parseCommandLineOptions

public XodusKVImplementation.Config parseCommandLineOptions(ArrayDeque<String> options)

Description copied from class: KVImplementation

Parse the specified command line options and return the resulting configuration, if possible.

At least one option must be recognized, indicating that this implementation is to be used, otherwise null should be returned.

Specified by:

parseCommandLineOptions in class KVImplementation<XodusKVImplementation.Config>

Parameters:

options - all command line options; upon return, recognized options should be removed

Returns:

configuration object representing the parsed options, or null if this implementation is not specified/configured

createKVDatabase

public XodusKVDatabase createKVDatabase(XodusKVImplementation.Config config,
                                        KVDatabase ignored,
                                        AtomicKVStore kvstore)

Description copied from class: KVImplementation

Create an KVDatabase using the specified configuration.

Specified by:

createKVDatabase in class KVImplementation<XodusKVImplementation.Config>

Parameters:

config - implementation configuration returned by parseCommandLineOptions()

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

getDescription

public String getDescription(XodusKVImplementation.Config config)

Description copied from class: KVImplementation

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

Specified by:

getDescription in class KVImplementation<XodusKVImplementation.Config>

Parameters:

config - implementation configuration returned by parseCommandLineOptions()

Returns:

human-readable description