-
-
Notifications
You must be signed in to change notification settings - Fork 723
/
OptionData.java
391 lines (371 loc) · 13.6 KB
/
OptionData.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
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* 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 net.dv8tion.jda.api.interactions.commands.build;
import net.dv8tion.jda.api.interactions.commands.Command;
import net.dv8tion.jda.api.interactions.commands.OptionType;
import net.dv8tion.jda.api.utils.data.DataArray;
import net.dv8tion.jda.api.utils.data.DataObject;
import net.dv8tion.jda.api.utils.data.SerializableData;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.Nonnull;
import java.util.*;
import java.util.stream.Collectors;
/**
* Builder for a Slash-Command option.
*/
public class OptionData implements SerializableData
{
private final OptionType type;
private String name, description;
private boolean isRequired;
private Map<String, Object> choices;
/**
* Create an option builder.
* <br>This option is not {@link #isRequired() required} by default.
*
* @param type
* The {@link OptionType}
* @param name
* The option name, 1-32 lowercase alphanumeric characters
* @param description
* The option description, 1-100 characters
*
* @throws IllegalArgumentException
* If any of the following requirements are not met
* <ul>
* <li>The name must be lowercase alphanumeric (with dash), 1-32 characters long</li>
* <li>The description must be 1-100 characters long</li>
* <li>The type must not be null</li>
* </ul>
*/
public OptionData(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description)
{
this(type, name, description, false);
}
/**
* Create an option builder.
*
* @param type
* The {@link OptionType}
* @param name
* The option name, 1-32 lowercase alphanumeric characters
* @param description
* The option description, 1-100 characters
* @param isRequired
* True, if this option is required
*
* @throws IllegalArgumentException
* If any of the following requirements are not met
* <ul>
* <li>The name must be lowercase alphanumeric (with dash), 1-32 characters long</li>
* <li>The description must be 1-100 characters long</li>
* <li>The type must not be null</li>
* </ul>
*/
public OptionData(@Nonnull OptionType type, @Nonnull String name, @Nonnull String description, boolean isRequired)
{
Checks.notNull(type, "Type");
Checks.notEmpty(name, "Name");
Checks.notEmpty(description, "Description");
Checks.notLonger(name, 32, "Name");
Checks.notLonger(description, 100, "Description");
Checks.matches(name, Checks.ALPHANUMERIC_WITH_DASH, "Name");
Checks.isLowercase(name, "Name");
this.type = type;
this.name = name;
this.description = description;
this.isRequired = isRequired;
if (type.canSupportChoices())
choices = new LinkedHashMap<>();
}
/**
* The {@link OptionType} for this option
*
* @return The {@link OptionType}
*/
@Nonnull
public OptionType getType()
{
return type;
}
/**
* The name for this option
*
* @return The name
*/
@Nonnull
public String getName()
{
return name;
}
/**
* The description for this option
*
* @return The description
*/
@Nonnull
public String getDescription()
{
return description;
}
/**
* Whether this option is required.
* <br>This can be configured with {@link #setRequired(boolean)}.
*
* <p>Required options must always be set by the command invocation.
*
* @return True, if this option is required
*/
public boolean isRequired()
{
return isRequired;
}
/**
* The choices for this option.
* <br>This is empty by default and can only be configured for specific option types.
*
* @return Immutable list of {@link net.dv8tion.jda.api.interactions.commands.Command.Choice Choices}
*
* @see #addChoice(String, int)
* @see #addChoice(String, String)
*/
@Nonnull
public List<Command.Choice> getChoices()
{
if (choices == null || choices.isEmpty())
return Collections.emptyList();
return choices.entrySet().stream()
.map(entry ->
{
if (entry.getValue() instanceof String)
return new Command.Choice(entry.getKey(), entry.getValue().toString());
return new Command.Choice(entry.getKey(), ((Number) entry.getValue()).longValue());
})
.collect(Collectors.toList());
}
/**
* Configure the name
*
* @param name
* The lowercase alphanumeric (with dash) name, 1-32 characters
*
* @throws IllegalArgumentException
* If the name is null, not alphanumeric, or not between 1-32 characters
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData setName(@Nonnull String name)
{
Checks.notEmpty(name, "Name");
Checks.notLonger(name, 32, "Name");
Checks.isLowercase(name, "Name");
Checks.matches(name, Checks.ALPHANUMERIC_WITH_DASH, "Name");
this.name = name;
return this;
}
/**
* Configure the description
*
* @param description
* The description, 1-100 characters
*
* @throws IllegalArgumentException
* If the name is null or not between 1-100 characters
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData setDescription(@Nonnull String description)
{
Checks.notEmpty(description, "Description");
Checks.notLonger(description, 100, "Description");
this.description = description;
return this;
}
/**
* Configure whether the user must set this option.
* <br>Required options must always be filled out when using the command.
*
* @param required
* True, if this option is required
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData setRequired(boolean required)
{
this.isRequired = required;
return this;
}
/**
* Add a predefined choice for this option.
* <br>The user can only provide one of the choices and cannot specify any other value.
*
* @param name
* The name used in the client
* @param value
* The value received in {@link net.dv8tion.jda.api.interactions.commands.OptionMapping OptionMapping}
*
* @throws IllegalArgumentException
* If the name is null, empty, or longer than 100 characters.
* Also thrown if this is not an option of type {@link OptionType#INTEGER} or more than 25 choices are provided.
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData addChoice(@Nonnull String name, int value)
{
Checks.notEmpty(name, "Name");
Checks.notLonger(name, 100, "Name");
Checks.check(choices.size() < 25, "Cannot have more than 25 choices for an option!");
if (type != OptionType.INTEGER)
throw new IllegalArgumentException("Cannot add int choice for OptionType." + type);
choices.put(name, value);
return this;
}
/**
* Add a predefined choice for this option.
* <br>The user can only provide one of the choices and cannot specify any other value.
*
* @param name
* The name used in the client
* @param value
* The value received in {@link net.dv8tion.jda.api.interactions.commands.OptionMapping OptionMapping}
*
* @throws IllegalArgumentException
* If the name or value is null, empty, or longer than 100 characters.
* Also thrown if this is not an option of type {@link OptionType#STRING} or more than 25 choices are provided.
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData addChoice(@Nonnull String name, @Nonnull String value)
{
Checks.notEmpty(name, "Name");
Checks.notEmpty(value, "Value");
Checks.notLonger(name, 100, "Name");
Checks.notLonger(value, 100, "Value");
Checks.check(choices.size() < 25, "Cannot have more than 25 choices for an option!");
if (type != OptionType.STRING)
throw new IllegalArgumentException("Cannot add string choice for OptionType." + type);
choices.put(name, value);
return this;
}
/**
* Adds up to 25 predefined choices for this option.
* <br>The user can only provide one of the choices and cannot specify any other value.
*
* @param choices
* The choices to add
*
* @throws IllegalArgumentException
* If any name or value is null, empty, or longer than 100 characters.
* Also thrown if this is not an option type is incompatible with the choice type or more than 25 choices are provided.
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData addChoices(@Nonnull Command.Choice... choices)
{
if (this.choices == null)
throw new IllegalStateException("Cannot add choices for an option of type " + type);
Checks.noneNull(choices, "Choices");
Checks.check(choices.length + this.choices.size() <= 25, "Cannot have more than 25 choices for one option!");
for (Command.Choice choice : choices)
{
if (type == OptionType.INTEGER)
addChoice(choice.getName(), (int) choice.getAsLong());
else if (type == OptionType.STRING)
addChoice(choice.getName(), choice.getAsString());
else
throw new IllegalArgumentException("Cannot add choice for type " + type);
}
return this;
}
/**
* Adds up to 25 predefined choices for this option.
* <br>The user can only provide one of the choices and cannot specify any other value.
*
* @param choices
* The choices to add
*
* @throws IllegalArgumentException
* If any name or value is null, empty, or longer than 100 characters.
* Also thrown if this is not an option type is incompatible with the choice type or more than 25 choices are provided.
*
* @return The OptionData instance, for chaining
*/
@Nonnull
public OptionData addChoices(@Nonnull Collection<? extends Command.Choice> choices)
{
Checks.noneNull(choices, "Choices");
return addChoices(choices.toArray(new Command.Choice[0]));
}
@Nonnull
@Override
public DataObject toData()
{
DataObject json = DataObject.empty()
.put("type", type.getKey())
.put("name", name)
.put("description", description);
if (type != OptionType.SUB_COMMAND && type != OptionType.SUB_COMMAND_GROUP)
json.put("required", isRequired);
if (choices != null && !choices.isEmpty())
{
json.put("choices", DataArray.fromCollection(choices.entrySet()
.stream()
.map(entry -> DataObject.empty().put("name", entry.getKey()).put("value", entry.getValue()))
.collect(Collectors.toList())));
}
return json;
}
/**
* Parses the provided serialization back into an OptionData instance.
* <br>This is the reverse function for {@link #toData()}.
*
* @param json
* The serialized {@link DataObject} representing the option
*
* @throws net.dv8tion.jda.api.exceptions.ParsingException
* If the serialized object is missing required fields
* @throws IllegalArgumentException
* If any of the values are failing the respective checks such as length
*
* @return The parsed OptionData instance, which can be further configured through setters
*/
@Nonnull
public static OptionData fromData(@Nonnull DataObject json)
{
String name = json.getString("name");
String description = json.getString("description");
OptionType type = OptionType.fromKey(json.getInt("type"));
OptionData option = new OptionData(type, name, description);
option.setRequired(json.getBoolean("required"));
json.optArray("choices").ifPresent(choices1 ->
choices1.stream(DataArray::getObject).forEach(o ->
{
Object value = o.get("value");
if (value instanceof Number)
option.addChoice(o.getString("name"), ((Number) value).intValue());
else
option.addChoice(o.getString("name"), value.toString());
})
);
return option;
}
}