-
Notifications
You must be signed in to change notification settings - Fork 25
/
KeyValueEntity.java
115 lines (99 loc) · 3.57 KB
/
KeyValueEntity.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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
/*
* 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.keyvalue;
import jakarta.nosql.ServiceLoaderProvider;
import jakarta.nosql.TypeSupplier;
import jakarta.nosql.Value;
import java.util.ServiceLoader;
import java.util.function.BiFunction;
/**
* A bucket unit, it's a tuple that contains key its respective value.
*/
public interface KeyValueEntity {
/**
* Creates a Key value instance
*
* @param key the key
* @param value the value
* @param <K> the key type
* @param <V> the value type
* @return a {@link KeyValueEntity} instance
* @throws NullPointerException when either key or value are null
*/
static <K, V> KeyValueEntity of(K key, V value) {
return ServiceLoaderProvider.get(KeyValueEntityProvider.class,
()-> ServiceLoader.load(KeyValueEntityProvider.class)).apply(key, value);
}
/**
* the key
*
* @return the value
*/
Object getKey();
/**
* Alias to {@link Value#get(Class)}
*
* @param clazz {@link Value#get(Class)}
* @param <K> {@link Value#get(Class)}
* @return {@link Value#get(Class)}
* @throws NullPointerException see {@link Value#get(Class)}
* @throws UnsupportedOperationException see {@link Value#get(Class)}
*/
<K> K getKey(Class<K> clazz);
/**
* Alias to {@link Value#get(TypeSupplier)}
*
* @param typeSupplier {@link Value#get(TypeSupplier)}
* @param <K> {@link Value#get(TypeSupplier)}
* @return {@link Value#get(TypeSupplier)}
* @throws NullPointerException see {@link Value#get(TypeSupplier)}
* @throws UnsupportedOperationException see {@link Value#get(TypeSupplier)}
*/
<K> K getKey(TypeSupplier<K> typeSupplier);
/**
* The value
*
* @return the value
* @see Value
*/
Object getValue();
/**
* Alias to {@link Value#get(Class)}
*
* @param clazz {@link Value#get(Class)}
* @param <V> {@link Value#get(Class)}
* @return {@link Value#get(Class)}
* @throws NullPointerException see {@link Value#get(Class)}
* @throws UnsupportedOperationException see {@link Value#get(Class)}
*/
<V> V getValue(Class<V> clazz);
/**
* Alias to {@link Value#get(TypeSupplier)}
*
* @param typeSupplier {@link Value#get(TypeSupplier)}
* @param <V> {@link Value#get(TypeSupplier)}
* @return {@link Value#get(TypeSupplier)}
* @throws NullPointerException see {@link Value#get(TypeSupplier)}
* @throws UnsupportedOperationException see {@link Value#get(TypeSupplier)}
*/
<V> V getValue(TypeSupplier<V> typeSupplier);
/**
* A provider of {@link KeyValueEntity} where it will return from two values where the first one is the key
* and the second one is the value of the entity.
*/
interface KeyValueEntityProvider extends BiFunction<Object, Object, KeyValueEntity> {
}
}