-
Notifications
You must be signed in to change notification settings - Fork 863
/
DriverConfig.java
49 lines (44 loc) · 1.81 KB
/
DriverConfig.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
/*
* Copyright DataStax, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.oss.driver.api.core.config;
import java.util.Map;
/**
* The configuration of the driver.
*
* <p>It is composed of options, that are organized into profiles. There is a default profile that
* is always present, and additional, named profiles, that can override part of the options.
* Profiles can be used to categorize queries that use the same parameters (for example, an
* "analytics" profile vs. a "transactional" profile).
*/
public interface DriverConfig {
/**
* Alias to get the default profile, which is stored under the name {@link
* DriverConfigProfile#DEFAULT_NAME} and always present.
*/
default DriverConfigProfile getDefaultProfile() {
return getProfile(DriverConfigProfile.DEFAULT_NAME);
}
/** @throws IllegalArgumentException if there is no profile with this name. */
DriverConfigProfile getProfile(String profileName);
/**
* Returns an <b>immutable</b> view of all named profiles (including the default profile).
*
* <p>Implementations typically return a defensive copy of their internal state; therefore this
* should not be used in performance-sensitive parts of the code, see {@link #getProfile(String)}
* instead.
*/
Map<String, DriverConfigProfile> getProfiles();
}