Class OptionHelpers

java.lang.Object

io.nosqlbench.adapter.cqld4.optionhelpers.OptionHelpers

All Implemented Interfaces:

NBCanConfigure, NBConfigModelProvider, NBConfigurable

public class OptionHelpers
extends Object
implements NBConfigurable

Provide a concise way to express configuration option helpers which simplify usage of the long-form options with the latest driver. Essentially, make lambda-style definition of optional parameter handling _readable_, and provide a working blueprint for how to handle config helpers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OptionHelpers.Modifier

Constructor Summary

Constructors

Constructor	Description
OptionHelpers(com.datastax.oss.driver.api.core.config.OptionsMap options)

Method Summary

Modifier and Type	Method	Description
void	add(String name, String description, OptionHelpers.Modifier modifier)
void	applyConfig(NBConfiguration cfg)	Implementors should take care to ensure that this can be called after initial construction without unexpected interactions between construction parameters and configuration parameters.
NBConfigModel	getConfigModel()	Implement this method by returning an instance of ConfigModel.

Methods inherited from class java.lang.Object

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

Constructor Details

OptionHelpers

public OptionHelpers(com.datastax.oss.driver.api.core.config.OptionsMap options)

Method Details

add

public void add(String name,
 String description,
 OptionHelpers.Modifier modifier)

applyConfig

public void applyConfig(NBConfiguration cfg)

Description copied from interface: NBConfigurable

Implementors should take care to ensure that this can be called after initial construction without unexpected interactions between construction parameters and configuration parameters.

Specified by:

applyConfig in interface NBCanConfigure

Specified by:

applyConfig in interface NBConfigurable

Parameters:

cfg - The configuration data to be applied to a new instance

getConfigModel

public NBConfigModel getConfigModel()

Description copied from interface: NBConfigurable

Implement this method by returning an instance of ConfigModel. Any configuration which is provided to the NBConfigurable.applyConfig(NBConfiguration) method will be validated through this model. A configuration model is required in order to build a validated configuration from source data provided by a user.

Specified by:

getConfigModel in interface NBConfigModelProvider

Specified by:

getConfigModel in interface NBConfigurable

Returns:

A valid configuration model for the implementing class