-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
ComponentBuilder.java
414 lines (380 loc) · 11.9 KB
/
ComponentBuilder.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
/*
* This file is part of adventure, licensed under the MIT License.
*
* Copyright (c) 2017-2021 KyoriPowered
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package net.kyori.adventure.text;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Function;
import net.kyori.adventure.key.Key;
import net.kyori.adventure.text.event.ClickEvent;
import net.kyori.adventure.text.event.HoverEventSource;
import net.kyori.adventure.text.format.Style;
import net.kyori.adventure.text.format.TextColor;
import net.kyori.adventure.text.format.TextDecoration;
import net.kyori.adventure.util.Buildable;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
/**
* A component builder.
*
* @param <C> the component type
* @param <B> the builder type
* @since 4.0.0
*/
public interface ComponentBuilder<C extends BuildableComponent<C, B>, B extends ComponentBuilder<C, B>> extends Buildable.Builder<C>, ComponentBuilderApplicable, ComponentLike {
/**
* Appends a component to this component.
*
* @param component the component to append
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B append(final @NotNull Component component);
/**
* Appends a component to this component.
*
* @param component the component to append
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
default @NotNull B append(final @NotNull ComponentLike component) {
return this.append(component.asComponent());
}
/**
* Appends a component to this component.
*
* @param builder the component to append
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
default @NotNull B append(final @NotNull ComponentBuilder<?, ?> builder) {
return this.append(builder.build());
}
/**
* Appends components to this component.
*
* @param components the components to append
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B append(final @NotNull Component@NotNull... components);
/**
* Appends components to this component.
*
* @param components the components to append
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B append(final @NotNull ComponentLike@NotNull... components);
/**
* Appends components to this component.
*
* @param components the components to append
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B append(final @NotNull Iterable<? extends ComponentLike> components);
/**
* Applies an action to this builder.
*
* @param consumer the action
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@SuppressWarnings("unchecked")
default @NotNull B apply(final @NotNull Consumer<? super ComponentBuilder<?, ?>> consumer) {
consumer.accept(this);
return (B) this;
}
/**
* Applies an action to this component and all child components if they are
* an instance of {@link BuildableComponent}.
*
* @param action the action
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B applyDeep(final @NotNull Consumer<? super ComponentBuilder<?, ?>> action);
/**
* Replaces each child of this component with the resultant component from the function.
*
* @param function the mapping function
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B mapChildren(final @NotNull Function<BuildableComponent<?, ?>, ? extends BuildableComponent<?, ?>> function);
/**
* Replaces each child and sub-child of this component with the resultant
* component of the function.
*
* @param function the mapping function
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B mapChildrenDeep(final @NotNull Function<BuildableComponent<?, ?>, ? extends BuildableComponent<?, ?>> function);
/**
* Get an unmodifiable list containing all children currently in this builder.
*
* @return the list of children
* @since 4.6.0
*/
@NotNull List<Component> children();
/**
* Sets the style.
*
* @param style the style
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B style(final @NotNull Style style);
/**
* Configures the style.
*
* @param consumer the style consumer
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B style(final @NotNull Consumer<Style.Builder> consumer);
/**
* Sets the font of this component.
*
* @param font the font
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B font(final @Nullable Key font);
/**
* Sets the color of this component.
*
* @param color the color
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B color(final @Nullable TextColor color);
/**
* Sets the color of this component if there isn't one set already.
*
* @param color the color
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B colorIfAbsent(final @Nullable TextColor color);
/**
* Sets the state of a set of decorations to {@code flag} on this component.
*
* @param decorations the decorations
* @param flag {@code true} if this component should have the decorations, {@code false} if
* this component should not have the decorations
* @return this builder
* @since 4.0.0
*/
@Contract("_, _ -> this")
@SuppressWarnings("unchecked")
default @NotNull B decorations(final @NotNull Set<TextDecoration> decorations, final boolean flag) {
final TextDecoration.State state = TextDecoration.State.byBoolean(flag);
decorations.forEach(decoration -> this.decoration(decoration, state));
return (B) this;
}
/**
* Sets the state of {@code decoration} to {@link TextDecoration.State#TRUE}.
*
* @param decoration the decoration
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
default @NotNull B decorate(final @NotNull TextDecoration decoration) {
return this.decoration(decoration, TextDecoration.State.TRUE);
}
/**
* Sets {@code decorations} to {@link TextDecoration.State#TRUE}.
*
* @param decorations the decorations
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@SuppressWarnings("unchecked")
default @NotNull B decorate(final @NotNull TextDecoration@NotNull... decorations) {
for (int i = 0, length = decorations.length; i < length; i++) {
this.decorate(decorations[i]);
}
return (B) this;
}
/**
* Sets the state of a decoration on this component.
*
* @param decoration the decoration
* @param flag {@code true} if this component should have the decoration, {@code false} if
* this component should not have the decoration
* @return this builder
* @since 4.0.0
*/
@Contract("_, _ -> this")
default @NotNull B decoration(final @NotNull TextDecoration decoration, final boolean flag) {
return this.decoration(decoration, TextDecoration.State.byBoolean(flag));
}
/**
* Sets decorations for this component's style using the specified {@code decorations} map.
*
* <p>If a given decoration does not have a value explicitly set, the value of that particular decoration is not changed.</p>
*
* @param decorations a map containing text decorations and their respective state.
* @return this builder
* @since 4.10.0
*/
@Contract("_ -> this")
@SuppressWarnings("unchecked")
default @NotNull B decorations(final @NotNull Map<TextDecoration, TextDecoration.State> decorations) {
for (final Map.Entry<TextDecoration, TextDecoration.State> entry : decorations.entrySet()) {
this.decoration(entry.getKey(), entry.getValue());
}
return (B) this;
}
/**
* Sets the value of a decoration on this component.
*
* @param decoration the decoration
* @param state {@link TextDecoration.State#TRUE} if this component should have the
* decoration, {@link TextDecoration.State#FALSE} if this component should not
* have the decoration, and {@link TextDecoration.State#NOT_SET} if the decoration
* should not have a set value
* @return this builder
* @since 4.0.0
*/
@Contract("_, _ -> this")
@NotNull B decoration(final @NotNull TextDecoration decoration, final TextDecoration.@NotNull State state);
/**
* Sets the click event of this component.
*
* @param event the click event
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B clickEvent(final @Nullable ClickEvent event);
/**
* Sets the hover event of this component.
*
* @param source the hover event source
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B hoverEvent(final @Nullable HoverEventSource<?> source);
/**
* Sets the string to be inserted when this component is shift-clicked.
*
* @param insertion the insertion string
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@NotNull B insertion(final @Nullable String insertion);
/**
* Merges styling from another component into this component.
*
* @param that the other component
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
default @NotNull B mergeStyle(final @NotNull Component that) {
return this.mergeStyle(that, Style.Merge.all());
}
/**
* Merges styling from another component into this component.
*
* @param that the other component
* @param merges the parts to merge
* @return this builder
* @since 4.0.0
*/
@Contract("_, _ -> this")
default @NotNull B mergeStyle(final @NotNull Component that, final Style.@NotNull Merge@NotNull... merges) {
return this.mergeStyle(that, Style.Merge.of(merges));
}
/**
* Merges styling from another component into this component.
*
* @param that the other component
* @param merges the parts to merge
* @return this builder
* @since 4.0.0
*/
@Contract("_, _ -> this")
@NotNull B mergeStyle(final @NotNull Component that, final @NotNull Set<Style.Merge> merges);
/**
* Resets all styling on this component.
*
* @return this builder
* @since 4.0.0
*/
@NotNull B resetStyle();
/**
* Build a component.
*
* @return the component
*/
@Override
@NotNull C build();
/**
* Applies {@code applicable}.
*
* @param applicable the thing to apply
* @return this builder
* @since 4.0.0
*/
@Contract("_ -> this")
@SuppressWarnings("unchecked")
default @NotNull B applicableApply(final @NotNull ComponentBuilderApplicable applicable) {
applicable.componentBuilderApply(this);
return (B) this;
}
@Override
default void componentBuilderApply(final @NotNull ComponentBuilder<?, ?> component) {
component.append(this);
}
@Override
default @NotNull Component asComponent() {
return this.build();
}
}