-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ScanOptions.java
197 lines (163 loc) · 4.78 KB
/
ScanOptions.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
/*
* Copyright 2014-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.util.StringJoiner;
import org.springframework.data.redis.connection.DataType;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* Options to be used for with {@literal SCAN} commands.
*
* @author Christoph Strobl
* @author Thomas Darimont
* @author Mark Paluch
* @since 1.4
* @see KeyScanOptions
*/
public class ScanOptions {
/**
* Constant to apply default {@link ScanOptions} without setting a limit or matching a pattern.
*/
public static ScanOptions NONE = new ScanOptions(null, null, null);
private final @Nullable Long count;
private final @Nullable String pattern;
private final @Nullable byte[] bytePattern;
ScanOptions(@Nullable Long count, @Nullable String pattern, @Nullable byte[] bytePattern) {
this.count = count;
this.pattern = pattern;
this.bytePattern = bytePattern;
}
/**
* Static factory method that returns a new {@link ScanOptionsBuilder}.
*
* @return
*/
public static ScanOptionsBuilder scanOptions() {
return new ScanOptionsBuilder();
}
@Nullable
public Long getCount() {
return count;
}
@Nullable
public String getPattern() {
if (bytePattern != null && pattern == null) {
return new String(bytePattern);
}
return pattern;
}
@Nullable
public byte[] getBytePattern() {
if (bytePattern == null && pattern != null) {
return pattern.getBytes();
}
return bytePattern;
}
public String toOptionString() {
if (this.equals(ScanOptions.NONE)) {
return "";
}
StringJoiner joiner = new StringJoiner(", ");
if (this.getCount() != null) {
joiner.add("'count' " + this.getCount());
}
String pattern = getPattern();
if (StringUtils.hasText(pattern)) {
joiner.add("'match' '" + pattern + "'");
}
return joiner.toString();
}
/**
* @author Christoph Strobl
* @author Mark Paluch
* @since 1.4
*/
public static class ScanOptionsBuilder {
@Nullable Long count;
@Nullable String pattern;
@Nullable byte[] bytePattern;
@Nullable DataType type;
ScanOptionsBuilder() {}
/**
* Returns the current {@link ScanOptionsBuilder} configured with the given {@code count}.
*
* @param count
* @return this.
*/
public ScanOptionsBuilder count(long count) {
this.count = count;
return this;
}
/**
* Returns the current {@link ScanOptionsBuilder} configured with the given {@code pattern}.
*
* @param pattern
* @return this.
*/
public ScanOptionsBuilder match(String pattern) {
this.pattern = pattern;
return this;
}
/**
* Returns the current {@link ScanOptionsBuilder} configured with the given {@code pattern}.
*
* @param pattern
* @return this.
* @since 2.6
*/
public ScanOptionsBuilder match(byte[] pattern) {
this.bytePattern = pattern;
return this;
}
/**
* Returns the current {@link ScanOptionsBuilder} configured with the given {@code type}. <br />
* Please verify the the targeted command supports the
* <a href="https://redis.io/commands/SCAN#the-type-option">TYPE</a> option before use.
*
* @param type must not be {@literal null}. Either do not set or use {@link DataType#NONE}.
* @return this.
* @since 2.6
*/
public ScanOptionsBuilder type(DataType type) {
Assert.notNull(type, "Type must not be null Use NONE instead");
this.type = type;
return this;
}
/**
* Returns the current {@link ScanOptionsBuilder} configured with the given {@code type}.
*
* @param type the textual representation of {@link DataType#fromCode(String)}. Must not be {@literal null}.
* @return this.
* @throws IllegalArgumentException if given type is {@literal null} or unknown.
*/
public ScanOptionsBuilder type(String type) {
Assert.notNull(type, "Type must not be null");
return type(DataType.fromCode(type));
}
/**
* Builds a new {@link ScanOptions} objects.
*
* @return a new {@link ScanOptions} objects.
*/
public ScanOptions build() {
if (type != null && !DataType.NONE.equals(type)) {
return new KeyScanOptions(count, pattern, bytePattern, type.code());
}
return new ScanOptions(count, pattern, bytePattern);
}
}
}