-
Notifications
You must be signed in to change notification settings - Fork 25
/
ColumnConfiguration.java
80 lines (70 loc) · 3.16 KB
/
ColumnConfiguration.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
* Copyright (c) 2019 Otavio Santana and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.nosql.column;
import jakarta.nosql.ServiceLoaderProvider;
import jakarta.nosql.Settings;
import java.util.ServiceLoader;
/**
* The Jakarta NoSQL communication configuration to create a {@link ColumnFamilyManagerFactory}
*/
public interface ColumnConfiguration {
/**
* Reads configuration either from default configuration or a file defined by NoSQL
* provider and then creates a {@link ColumnFamilyManagerFactory} instance.
*
* @param <T> the ColumnFamilyManagerFactory type
* @return a {@link ColumnFamilyManagerFactory}
*/
<T extends ColumnFamilyManagerFactory> T get();
/**
* Reads configuration from the {@link Settings} instance, the parameters are defined by NoSQL
* provider, then creates a {@link ColumnFamilyManagerFactory} instance.
*
* @param <T> the ColumnFamilyManagerFactory type
* @param settings the settings
* @return a {@link ColumnFamilyManagerFactory}
* @throws NullPointerException when settings is null
* @see Settings
* @see Settings {@link java.util.Map}
*/
<T extends ColumnFamilyManagerFactory> T get(Settings settings);
/**
* creates and returns a {@link ColumnConfiguration} instance from {@link java.util.ServiceLoader}
*
* @param <T> the configuration type
* @return {@link ColumnConfiguration} instance
* @throws jakarta.nosql.ProviderNotFoundException when the provider is not found
* @throws jakarta.nosql.NonUniqueResultException when there is more than one KeyValueConfiguration
*/
static <T extends ColumnConfiguration> T getConfiguration() {
return (T) ServiceLoaderProvider.getUnique(ColumnConfiguration.class,
()-> ServiceLoader.load(ColumnConfiguration.class));
}
/**
* creates and returns a {@link ColumnConfiguration} instance from {@link java.util.ServiceLoader}
* for a particular provider implementation.
*
* @param <T> the configuration type
* @param service the particular provider
* @return {@link ColumnConfiguration} instance
* @throws jakarta.nosql.ProviderNotFoundException when the provider is not found
* @throws jakarta.nosql.NonUniqueResultException when there is more than one KeyValueConfiguration
*/
static <T extends ColumnConfiguration> T getConfiguration(Class<T> service) {
return ServiceLoaderProvider.getUnique(ColumnConfiguration.class,
()-> ServiceLoader.load(ColumnConfiguration.class), service);
}
}