-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ValueOperations.java
414 lines (372 loc) · 13.8 KB
/
ValueOperations.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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
/*
* Copyright 2011-2024 the original author or authors.
*
* 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
*
* https://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 org.springframework.data.redis.core;
import java.time.Duration;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import org.springframework.data.redis.connection.BitFieldSubCommands;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Redis operations for simple (or in Redis terminology 'string') values.
*
* @author Costin Leau
* @author Christoph Strobl
* @author Mark Paluch
* @author Jiahe Cai
*/
public interface ValueOperations<K, V> {
/**
* Set {@code value} for {@code key}.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
*/
void set(K key, V value);
/**
* Set the {@code value} and expiration {@code timeout} for {@code key}.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @param timeout the key expiration timeout.
* @param unit must not be {@literal null}.
* @see <a href="https://redis.io/commands/setex">Redis Documentation: SETEX</a>
*/
void set(K key, V value, long timeout, TimeUnit unit);
/**
* Set the {@code value} and expiration {@code timeout} for {@code key}.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @param timeout must not be {@literal null}.
* @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present.
* @see <a href="https://redis.io/commands/setex">Redis Documentation: SETEX</a>
* @since 2.1
*/
default void set(K key, V value, Duration timeout) {
Assert.notNull(timeout, "Timeout must not be null");
if (TimeoutUtils.hasMillis(timeout)) {
set(key, value, timeout.toMillis(), TimeUnit.MILLISECONDS);
} else {
set(key, value, timeout.getSeconds(), TimeUnit.SECONDS);
}
}
/**
* Set {@code key} to hold the string {@code value} if {@code key} is absent.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/setnx">Redis Documentation: SETNX</a>
*/
@Nullable
Boolean setIfAbsent(K key, V value);
/**
* Set {@code key} to hold the string {@code value} and expiration {@code timeout} if {@code key} is absent.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @param timeout the key expiration timeout.
* @param unit must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.1
* @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
*/
@Nullable
Boolean setIfAbsent(K key, V value, long timeout, TimeUnit unit);
/**
* Set {@code key} to hold the string {@code value} and expiration {@code timeout} if {@code key} is absent.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @param timeout must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present.
* @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
* @since 2.1
*/
@Nullable
default Boolean setIfAbsent(K key, V value, Duration timeout) {
Assert.notNull(timeout, "Timeout must not be null");
if (TimeoutUtils.hasMillis(timeout)) {
return setIfAbsent(key, value, timeout.toMillis(), TimeUnit.MILLISECONDS);
}
return setIfAbsent(key, value, timeout.getSeconds(), TimeUnit.SECONDS);
}
/**
* Set {@code key} to hold the string {@code value} if {@code key} is present.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @return command result indicating if the key has been set.
* @throws IllegalArgumentException if either {@code key} or {@code value} is not present.
* @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
* @since 2.1
*/
@Nullable
Boolean setIfPresent(K key, V value);
/**
* Set {@code key} to hold the string {@code value} and expiration {@code timeout} if {@code key} is present.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @param timeout the key expiration timeout.
* @param unit must not be {@literal null}.
* @return command result indicating if the key has been set.
* @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present.
* @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
* @since 2.1
*/
@Nullable
Boolean setIfPresent(K key, V value, long timeout, TimeUnit unit);
/**
* Set {@code key} to hold the string {@code value} and expiration {@code timeout} if {@code key} is present.
*
* @param key must not be {@literal null}.
* @param value must not be {@literal null}.
* @param timeout must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @throws IllegalArgumentException if either {@code key}, {@code value} or {@code timeout} is not present.
* @see <a href="https://redis.io/commands/set">Redis Documentation: SET</a>
* @since 2.1
*/
@Nullable
default Boolean setIfPresent(K key, V value, Duration timeout) {
Assert.notNull(timeout, "Timeout must not be null");
if (TimeoutUtils.hasMillis(timeout)) {
return setIfPresent(key, value, timeout.toMillis(), TimeUnit.MILLISECONDS);
}
return setIfPresent(key, value, timeout.getSeconds(), TimeUnit.SECONDS);
}
/**
* Set multiple keys to multiple values using key-value pairs provided in {@code tuple}.
*
* @param map must not be {@literal null}.
* @see <a href="https://redis.io/commands/mset">Redis Documentation: MSET</a>
*/
void multiSet(Map<? extends K, ? extends V> map);
/**
* Set multiple keys to multiple values using key-value pairs provided in {@code tuple} only if the provided key does
* not exist.
*
* @param map must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/msetnx">Redis Documentation: MSETNX</a>
*/
@Nullable
Boolean multiSetIfAbsent(Map<? extends K, ? extends V> map);
/**
* Get the value of {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when key does not exist or used in pipeline / transaction.
* @see <a href="https://redis.io/commands/get">Redis Documentation: GET</a>
*/
@Nullable
V get(Object key);
/**
* Return the value at {@code key} and delete the key.
*
* @param key must not be {@literal null}.
* @return {@literal null} when key does not exist or used in pipeline / transaction.
* @see <a href="https://redis.io/commands/getdel">Redis Documentation: GETDEL</a>
* @since 2.6
*/
@Nullable
V getAndDelete(K key);
/**
* Return the value at {@code key} and expire the key by applying {@code timeout}.
*
* @param key must not be {@literal null}.
* @param timeout
* @param unit must not be {@literal null}.
* @return {@literal null} when key does not exist or used in pipeline / transaction.
* @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
* @since 2.6
*/
@Nullable
V getAndExpire(K key, long timeout, TimeUnit unit);
/**
* Return the value at {@code key} and expire the key by applying {@code timeout}.
*
* @param key must not be {@literal null}.
* @param timeout must not be {@literal null}.
* @return {@literal null} when key does not exist or used in pipeline / transaction.
* @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
* @since 2.6
*/
@Nullable
V getAndExpire(K key, Duration timeout);
/**
* Return the value at {@code key} and persist the key. This operation removes any TTL that is associated with
* {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when key does not exist or used in pipeline / transaction.
* @see <a href="https://redis.io/commands/getex">Redis Documentation: GETEX</a>
* @since 2.6
*/
@Nullable
V getAndPersist(K key);
/**
* Set {@code value} of {@code key} and return its old value.
*
* @param key must not be {@literal null}.
* @return {@literal null} when key does not exist or used in pipeline / transaction.
* @see <a href="https://redis.io/commands/getset">Redis Documentation: GETSET</a>
*/
@Nullable
V getAndSet(K key, V value);
/**
* Get multiple {@code keys}. Values are in the order of the requested keys Absent field values are represented using
* {@code null} in the resulting {@link List}.
*
* @param keys must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/mget">Redis Documentation: MGET</a>
*/
@Nullable
List<V> multiGet(Collection<K> keys);
/**
* Increment an integer value stored as string value under {@code key} by one.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.1
* @see <a href="https://redis.io/commands/incr">Redis Documentation: INCR</a>
*/
@Nullable
Long increment(K key);
/**
* Increment an integer value stored as string value under {@code key} by {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/incrby">Redis Documentation: INCRBY</a>
*/
@Nullable
Long increment(K key, long delta);
/**
* Increment a floating point number value stored as string value under {@code key} by {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/incrbyfloat">Redis Documentation: INCRBYFLOAT</a>
*/
@Nullable
Double increment(K key, double delta);
/**
* Decrement an integer value stored as string value under {@code key} by one.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.1
* @see <a href="https://redis.io/commands/decr">Redis Documentation: DECR</a>
*/
@Nullable
Long decrement(K key);
/**
* Decrement an integer value stored as string value under {@code key} by {@code delta}.
*
* @param key must not be {@literal null}.
* @param delta
* @return {@literal null} when used in pipeline / transaction.
* @since 2.1
* @see <a href="https://redis.io/commands/decrby">Redis Documentation: DECRBY</a>
*/
@Nullable
Long decrement(K key, long delta);
/**
* Append a {@code value} to {@code key}.
*
* @param key must not be {@literal null}.
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/append">Redis Documentation: APPEND</a>
*/
@Nullable
Integer append(K key, String value);
/**
* Get a substring of value of {@code key} between {@code begin} and {@code end}.
*
* @param key must not be {@literal null}.
* @param start
* @param end
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/getrange">Redis Documentation: GETRANGE</a>
*/
@Nullable
String get(K key, long start, long end);
/**
* Overwrite parts of {@code key} starting at the specified {@code offset} with given {@code value}.
*
* @param key must not be {@literal null}.
* @param value
* @param offset
* @see <a href="https://redis.io/commands/setrange">Redis Documentation: SETRANGE</a>
*/
void set(K key, V value, long offset);
/**
* Get the length of the value stored at {@code key}.
*
* @param key must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @see <a href="https://redis.io/commands/strlen">Redis Documentation: STRLEN</a>
*/
@Nullable
Long size(K key);
/**
* Sets the bit at {@code offset} in value stored at {@code key}.
*
* @param key must not be {@literal null}.
* @param offset
* @param value
* @return {@literal null} when used in pipeline / transaction.
* @since 1.5
* @see <a href="https://redis.io/commands/setbit">Redis Documentation: SETBIT</a>
*/
@Nullable
Boolean setBit(K key, long offset, boolean value);
/**
* Get the bit value at {@code offset} of value at {@code key}.
*
* @param key must not be {@literal null}.
* @param offset
* @return {@literal null} when used in pipeline / transaction.
* @since 1.5
* @see <a href="https://redis.io/commands/getbit">Redis Documentation: GETBIT</a>
*/
@Nullable
Boolean getBit(K key, long offset);
/**
* Get / Manipulate specific integer fields of varying bit widths and arbitrary non (necessary) aligned offset stored
* at a given {@code key}.
*
* @param key must not be {@literal null}.
* @param subCommands must not be {@literal null}.
* @return {@literal null} when used in pipeline / transaction.
* @since 2.1
* @see <a href="https://redis.io/commands/bitfield">Redis Documentation: BITFIELD</a>
*/
@Nullable
List<Long> bitField(K key, BitFieldSubCommands subCommands);
RedisOperations<K, V> getOperations();
}