Package xtdb.api

Class ModuleConfiguration.Builder

java.lang.Object

xtdb.api.ModuleConfiguration.Builder

Enclosing class:

ModuleConfiguration

public static final class ModuleConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ModuleConfiguration	build()
ModuleConfiguration.Builder	module(String module)	Specifies the constructor of this module.
ModuleConfiguration.Builder	set(String key, Object value)	Sets the configuration key to the given value
ModuleConfiguration.Builder	set(Map<String,Object> options)
ModuleConfiguration.Builder	with(String module)	Adds the submodule to this module with the default parameters
ModuleConfiguration.Builder	with(String key, String module)	Adds an existing top-level module to this submodule as a dependency.
ModuleConfiguration.Builder	with(String name, Consumer<ModuleConfiguration.Builder> f)	Adds the submodule to this module with the given configuration
ModuleConfiguration.Builder	with(String module, ModuleConfiguration configuration)	Adds the submodule to this module with the given configuration

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

set

public ModuleConfiguration.Builder set(String key,
 Object value)

Sets the configuration key to the given value

Returns:

this

module

public ModuleConfiguration.Builder module(String module)

Specifies the constructor of this module. If it is not explicitly provided, XTDB will use the key that this module is referenced by. e.g. if it is included under a `"xtdb.rocksdb/kv-store"` key, XTDB will use the `"xtdb.rocksdb/->kv-store"` Clojure function to construct the module.

Parameters:

module - the module constructor, e.g. `"xtdb.rocksdb/->kv-store"`

Returns:

this

set

public ModuleConfiguration.Builder set(Map<String,Object> options)

with

public ModuleConfiguration.Builder with(String module)

Adds the submodule to this module with the default parameters

Returns:

this

with

public ModuleConfiguration.Builder with(String module,
 ModuleConfiguration configuration)

Adds the submodule to this module with the given configuration

Returns:

this

with

public ModuleConfiguration.Builder with(String name,
 Consumer<ModuleConfiguration.Builder> f)

Adds the submodule to this module with the given configuration

Returns:

this

with

public ModuleConfiguration.Builder with(String key,
 String module)

Adds an existing top-level module to this submodule as a dependency.

Parameters:

key - the key under which the dependency will appear to this module

module - the key of the module to refer to

Returns:

this

build

public ModuleConfiguration build()