jakarta.nosql.document

Interface DocumentConfiguration

public interface DocumentConfiguration

The Jakarta NoSQL communication configuration to create a DocumentCollectionManagerFactory

Method Summary

Modifier and Type	Method and Description
<T extends DocumentCollectionManagerFactory> T	get() Reads configuration either from default configuration or a file defined by NoSQL provider and then creates a DocumentCollectionManagerFactory instance.
<T extends DocumentCollectionManagerFactory> T	get(Settings settings) Reads configuration from the Settings instance, the parameters are defined by NoSQL provider, then creates a DocumentCollectionManagerFactory instance.
static <T extends DocumentConfiguration> T	getConfiguration() creates and returns a DocumentConfiguration instance from ServiceLoader
static <T extends DocumentConfiguration> T	getConfiguration(Class<T> supplier) creates and returns a DocumentConfiguration instance from ServiceLoader for a particular provider implementation.

Method Detail

get

<T extends DocumentCollectionManagerFactory> T get()

Reads configuration either from default configuration or a file defined by NoSQL provider and then creates a DocumentCollectionManagerFactory instance.

Type Parameters:

T - the type to DocumentCollectionManagerFactory

Returns:

a DocumentCollectionManagerFactory instance

get

<T extends DocumentCollectionManagerFactory> T get(Settings settings)

Reads configuration from the Settings instance, the parameters are defined by NoSQL provider, then creates a DocumentCollectionManagerFactory instance.

Type Parameters:

T - the type to DocumentCollectionManagerFactory

Parameters:

settings - the settings

Returns:

a DocumentCollectionManagerFactory

Throws:

NullPointerException - when settings is null

See Also:

Settings, {@link java.util.Map}

getConfiguration

static <T extends DocumentConfiguration> T getConfiguration()

creates and returns a DocumentConfiguration instance from ServiceLoader

Type Parameters:

T - the configuration type

Returns:

DocumentConfiguration instance

Throws:

ProviderNotFoundException - when the provider is not found

NonUniqueResultException - when there is more than one KeyValueConfiguration

getConfiguration

static <T extends DocumentConfiguration> T getConfiguration(Class<T> supplier)

creates and returns a DocumentConfiguration instance from ServiceLoader for a particular provider implementation.

Type Parameters:

T - the configuration type

Parameters:

supplier - the particular provider

Returns:

DocumentConfiguration instance

Throws:

ProviderNotFoundException - when the provider is not found

NonUniqueResultException - when there is more than one KeyValueConfiguration