Module io.jstach.kiwi.kvs

Package io.jstach.kiwi.kvs

Class KeyValuesSystem.Builder

java.lang.Object

io.jstach.kiwi.kvs.KeyValuesSystem.Builder

Enclosing interface:

KeyValuesSystem

public static final class KeyValuesSystem.Builder
extends Object

A builder class for constructing instances of KeyValuesSystem with customizable components such as environment, loaders, and media finders.

Note: By default, the ServiceLoader is not enabled. If you wish to include services discovered via the ServiceLoader, you need to explicitly set it using serviceLoader(ServiceLoader).

Method Summary

Modifier and Type	Method	Description
KeyValuesSystem	build()	Builds and returns a new KeyValuesSystem instance configured with the provided settings.
KeyValuesSystem.Builder	environment(KeyValuesEnvironment environment)	Sets the KeyValuesEnvironment to be used by the KeyValuesSystem.
KeyValuesSystem.Builder	filter(KeyValuesServiceProvider.KeyValuesFilter filter)	Adds a filter to the filter chain.
KeyValuesSystem.Builder	loadFinder(KeyValuesServiceProvider.KeyValuesLoaderFinder loadFinder)	Adds a KeyValuesServiceProvider.KeyValuesLoaderFinder to the list of loader finders.
KeyValuesSystem.Builder	mediaFinder(KeyValuesServiceProvider.KeyValuesMediaFinder mediaFinder)	Adds a KeyValuesServiceProvider.KeyValuesMediaFinder to the list of media finders.
KeyValuesSystem.Builder	serviceLoader(ServiceLoader<KeyValuesServiceProvider> serviceLoader)	Sets the ServiceLoader for loading KeyValuesServiceProvider implementations.
KeyValuesSystem.Builder	useServiceLoader()	Uses the default service loader to load extensions.

Methods inherited from class java.lang.Object

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

Method Details

environment

public KeyValuesSystem.Builder environment(KeyValuesEnvironment environment)

Sets the KeyValuesEnvironment to be used by the KeyValuesSystem.

Parameters:

environment - the environment to set

Returns:

this builder instance

loadFinder

public KeyValuesSystem.Builder loadFinder(KeyValuesServiceProvider.KeyValuesLoaderFinder loadFinder)

Adds a KeyValuesServiceProvider.KeyValuesLoaderFinder to the list of loader finders.

Parameters:

loadFinder - the loader finder to add

Returns:

this builder instance

mediaFinder

public KeyValuesSystem.Builder mediaFinder(KeyValuesServiceProvider.KeyValuesMediaFinder mediaFinder)

Adds a KeyValuesServiceProvider.KeyValuesMediaFinder to the list of media finders.

Parameters:

mediaFinder - the media finder to add

Returns:

this builder instance

filter

public KeyValuesSystem.Builder filter(KeyValuesServiceProvider.KeyValuesFilter filter)

Adds a filter to the filter chain.

Parameters:

filter - the filter to add

Returns:

this

See Also:

• KeyValuesServiceProvider.KeyValuesFilter

serviceLoader

public KeyValuesSystem.Builder serviceLoader(ServiceLoader<KeyValuesServiceProvider> serviceLoader)

Sets the ServiceLoader for loading KeyValuesServiceProvider implementations. If this is set, the builder will include any KeyValuesServiceProvider.KeyValuesLoaderFinder and KeyValuesServiceProvider.KeyValuesMediaFinder instances found via the ServiceLoader.

Note: This is not enabled by default. You must explicitly set a service loader to include additional service-provided components.

Parameters:

serviceLoader - the service loader to set

Returns:

this builder instance

useServiceLoader

public KeyValuesSystem.Builder useServiceLoader()

Uses the default service loader to load extensions.

Returns:

this.

build

public KeyValuesSystem build()

Builds and returns a new KeyValuesSystem instance configured with the provided settings. The composite loader and media finders will include those added through this builder and, if specified, those found via the service loader.

Returns:

a new KeyValuesSystem instance