-
-
Notifications
You must be signed in to change notification settings - Fork 718
/
LayoutComponent.java
228 lines (212 loc) · 8.61 KB
/
LayoutComponent.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
/*
* 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.components;
import net.dv8tion.jda.api.interactions.components.buttons.Button;
import net.dv8tion.jda.api.interactions.components.buttons.ButtonStyle;
import net.dv8tion.jda.api.utils.data.SerializableData;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.*;
import java.util.stream.Collectors;
/**
* Represents a top-level layout used for {@link ActionComponent ActionComponents} such as {@link Button Buttons}.
*
* <p>Components must always be contained within such a layout.
*
* @see ActionRow
*/
public interface LayoutComponent extends SerializableData, Iterable<ActionComponent>, Component
{
/**
* List representation of this component layout.
* <br>This list is modifiable. Note that empty action rows are not supported.
*
* @return {@link List} of components in this action row
*/
@Nonnull
List<ActionComponent> getComponents();
/**
* List of buttons in this component layout.
*
* @return Immutable {@link List} of {@link Button Buttons}
*/
@Nonnull
List<Button> getButtons();
/**
* Whether all components in this layout are {@link ActionComponent#isDisabled() disabled}.
* <br>Note that this is a universal quantifier, which means false <b>does not</b> imply {@link #isEnabled()}!
*
* @return True, if all components are disabled
*/
default boolean isDisabled()
{
return getComponents().stream().allMatch(ActionComponent::isDisabled);
}
/**
* Whether all components in this layout are {@link ActionComponent#isDisabled() enabled}.
* <br>Note that this is a universal quantifier, which means false <b>does not</b> imply {@link #isDisabled()}!
*
* @return True, if all components are enabled
*/
default boolean isEnabled()
{
return getComponents().stream().noneMatch(ActionComponent::isDisabled);
}
/**
* Returns a new instance of this LayoutComponent with all components set to disabled/enabled.
* <br>This does not modify the layout this was called on. To do this in-place, you can use {@link #getComponents()}.
*
* @param disabled
* True if the components should be set to disabled, false if they should be enabled
*
* @return The new layout component with all components updated
*
* @see ActionComponent#withDisabled(boolean)
*/
@Nonnull
@CheckReturnValue
LayoutComponent withDisabled(boolean disabled);
/**
* Returns a new instance of this LayoutComponent with all components set to disabled.
* <br>This does not modify the layout this was called on. To do this in-place, you can use {@link #getComponents()}.
*
* @return The new layout component with all components updated
*
* @see ActionComponent#asDisabled()
*/
@Nonnull
@CheckReturnValue
LayoutComponent asDisabled();
/**
* Returns a new instance of this LayoutComponent with all components set to enabled.
* <br>This does not modify the layout this was called on. To do this in-place, you can use {@link #getComponents()}.
*
* @return The new layout component with all components updated
*
* @see ActionComponent#asEnabled()
*/
@Nonnull
@CheckReturnValue
LayoutComponent asEnabled();
/**
* Check whether this layout is empty.
* <br>Identical to {@code getComponents().isEmpty()}
*
* @return True, if this layout has no components
*/
default boolean isEmpty()
{
return getComponents().isEmpty();
}
/**
* Check whether this is a valid layout configuration.
* <br>This checks that there is at least one component in this layout and it does not violate {@link ActionComponent#getMaxPerRow()}.
*
* @return True, if this layout is valid
*/
default boolean isValid()
{
if (isEmpty())
return false;
List<ActionComponent> components = getComponents();
Map<Component.Type, List<ActionComponent>> groups = components.stream().collect(Collectors.groupingBy(Component::getType));
if (groups.size() > 1) // TODO: You can't mix components right now but maybe in the future, we need to check back on this when that happens
return false;
for (Map.Entry<Component.Type, List<ActionComponent>> entry : groups.entrySet())
{
Component.Type type = entry.getKey();
List<ActionComponent> list = entry.getValue();
if (list.size() > type.getMaxPerRow())
return false;
}
return true;
}
/**
* Find and replace a component in this layout.
* <br>This will locate and replace the existing component with the specified ID. If you provide null it will be removed instead.
*
* @param id
* The custom id of this component, can also be a URL for a {@link Button} with {@link ButtonStyle#LINK}
* @param newComponent
* The new component or null to remove it
*
* @throws IllegalArgumentException
* If the provided id is null
*
* @return The old {@link ActionComponent} that was replaced or removed
*/
@Nullable
default ActionComponent updateComponent(@Nonnull String id, @Nullable ActionComponent newComponent)
{
Checks.notNull(id, "ID");
List<ActionComponent> list = getComponents();
for (ListIterator<ActionComponent> it = list.listIterator(); it.hasNext();)
{
ActionComponent component = it.next();
if (id.equals(component.getId()) || (component instanceof Button && id.equals(((Button) component).getUrl())))
{
if (newComponent == null)
it.remove();
else
it.set(newComponent);
return component;
}
}
return null;
}
/**
* Find and replace a component in this list of layouts.
* <br>This will locate and replace the existing component with the specified ID. If you provide null it will be removed instead.
*
* <p>If one of the layouts is empty after removing the component, it will be removed from the list.
* This is an inplace operation and modifies the provided list directly.
*
* @param layouts
* The layouts to modify
* @param id
* The custom id of this component, can also be a URL for a {@link Button} with {@link ButtonStyle#LINK}
* @param newComponent
* The new component or null to remove it
*
* @throws UnsupportedOperationException
* If the list cannot be modified
* @throws IllegalArgumentException
* If the provided id or list is null or the replace operation results in an {@link #isValid() invalid} layout
*
* @return True, if any of the layouts was modified
*/
static boolean updateComponent(@Nonnull List<? extends LayoutComponent> layouts, @Nonnull String id, @Nullable ActionComponent newComponent)
{
Checks.notNull(layouts, "ComponentLayout");
Checks.notEmpty(id, "ID or URL");
for (Iterator<? extends LayoutComponent> it = layouts.iterator(); it.hasNext();)
{
LayoutComponent components = it.next();
ActionComponent oldComponent = components.updateComponent(id, newComponent);
if (oldComponent != null)
{
if (components.getComponents().isEmpty())
it.remove();
else if (!components.isValid() && newComponent != null)
throw new IllegalArgumentException("Cannot replace " + oldComponent.getType() + " with " + newComponent.getType() + " due to a violation of the layout maximum. The resulting ComponentLayout is invalid!");
return !Objects.equals(oldComponent, newComponent);
}
}
return false;
}
}