Class ConfigModel

java.lang.Object

io.nosqlbench.nb.api.config.standard.ConfigModel

All Implemented Interfaces:

NBConfigModel

public class ConfigModel
extends Object
implements NBConfigModel

Method Summary

Modifier and Type	Method	Description
ConfigModel	add(NBConfigModel otherModel)
<T> ConfigModel	add(Param<T> param)
NBConfiguration	apply(Map<String,?> config)
NBConfigModel	asReadOnly()	Add a param that, when present in a runtime configuration, will cause the config model to be expanded dynamically.
void	assertNoConflicts(Map<String,?> config, String type)
void	assertValidConfig(Map<String,?> config)
static <T> T	convertValueTo(String configName, String paramName, Object value, Class<T> type)
NBConfiguration	extractConfig(NBConfiguration cfg)	Extract the fields from the shared config into a separate config, removing those that are defined in this model and leaving extraneous config fields in the provided model.
NBConfiguration	extractConfig(Map<String,?> sharedConfig)	Extract the fields from the shared config into a separate config, removing those that are defined in this model and leaving extraneous config fields in the provided model.
Map<String,Param<?>>	getNamedParams()
Class<?>	getOf()
Param<?>	getParam(String... names)
List<Param<?>>	getParams()
void	log()
NBConfiguration	matchConfig(NBConfiguration cfg)
NBConfiguration	matchConfig(Map<String,?> sharedConfig)
static ConfigModel	of(Class<?> ofType)
static ConfigModel	of(Class<?> ofType, Param<?>... params)
String	toString()
ConfigModel	validIfRegex(String s)

Methods inherited from class java.lang.Object

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

Method Details

of

public static ConfigModel of(Class<?> ofType,
 Param<?>... params)

of

public static ConfigModel of(Class<?> ofType)

add

public <T> ConfigModel add(Param<T> param)

asReadOnly

public NBConfigModel asReadOnly()

Add a param that, when present in a runtime configuration, will cause the config model to be expanded dynamically. This is for scenarios in which you have external configurable resources or templates which contain their own models that can only be known at runtime.

getNamedParams

public Map<String,Param<?>> getNamedParams()

Specified by:

getNamedParams in interface NBConfigModel

getParams

public List<Param<?>> getParams()

Specified by:

getParams in interface NBConfigModel

getOf

public Class<?> getOf()

Specified by:

getOf in interface NBConfigModel

convertValueTo

public static <T> T convertValueTo(String configName,
 String paramName,
 Object value,
 Class<T> type)

extractConfig

public NBConfiguration extractConfig(Map<String,?> sharedConfig)

Description copied from interface: NBConfigModel

Extract the fields from the shared config into a separate config, removing those that are defined in this model and leaving extraneous config fields in the provided model. This method mutates the map that is provided.

Specified by:

extractConfig in interface NBConfigModel

Parameters:

sharedConfig - A config map which can provide fields to multiple models

Returns:

A new configuration for the extracted fields only.

matchConfig

public NBConfiguration matchConfig(Map<String,?> sharedConfig)

Specified by:

matchConfig in interface NBConfigModel

extractConfig

public NBConfiguration extractConfig(NBConfiguration cfg)

Description copied from interface: NBConfigModel

Extract the fields from the shared config into a separate config, removing those that are defined in this model and leaving extraneous config fields in the provided model. This method mutates the map that is provided.

Specified by:

extractConfig in interface NBConfigModel

Parameters:

cfg - A config map which can provide fields to multiple models

Returns:

A new configuration for the extracted fields only.

matchConfig

public NBConfiguration matchConfig(NBConfiguration cfg)

Specified by:

matchConfig in interface NBConfigModel

apply

public NBConfiguration apply(Map<String,?> config)

Specified by:

apply in interface NBConfigModel

assertNoConflicts

public void assertNoConflicts(Map<String,?> config,
 String type)

Specified by:

assertNoConflicts in interface NBConfigModel

assertValidConfig

public void assertValidConfig(Map<String,?> config)

Specified by:

assertValidConfig in interface NBConfigModel

getParam

public Param<?> getParam(String... names)

Specified by:

getParam in interface NBConfigModel

validIfRegex

public ConfigModel validIfRegex(String s)

add

public ConfigModel add(NBConfigModel otherModel)

Specified by:

add in interface NBConfigModel

log

public void log()

Specified by:

log in interface NBConfigModel

toString

public String toString()

Overrides:

toString in class Object