/
PermOverrideManager.java
304 lines (286 loc) · 11.4 KB
/
PermOverrideManager.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
/*
* 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.managers;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.entities.Guild;
import net.dv8tion.jda.api.entities.PermissionOverride;
import net.dv8tion.jda.api.entities.channel.attribute.IPermissionContainer;
import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
import net.dv8tion.jda.api.entities.channel.unions.IPermissionContainerUnion;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import java.util.Collection;
/**
* Manager providing functionality to update one or more fields for a {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* <p><b>Example</b>
* <pre>{@code
* manager.setDenied(Permission.MESSAGE_SEND)
* .setAllowed(Permission.VIEW_CHANNEL)
* .queue();
* manager.reset(PermOverrideManager.DENIED | PermOverrideManager.ALLOWED)
* .grant(Permission.MESSAGE_SEND)
* .clear(Permission.MESSAGE_MANAGE)
* .queue();
* }</pre>
*
* @see net.dv8tion.jda.api.entities.PermissionOverride#getManager()
*/
public interface PermOverrideManager extends Manager<PermOverrideManager>
{
/** Used to reset the denied field */
long DENIED = 1;
/** Used to reset the granted field */
long ALLOWED = 1 << 1;
/** Used to reset <b>all</b> permissions to their original value */
long PERMISSIONS = ALLOWED | DENIED;
/**
* Resets the fields specified by the provided bit-flag pattern.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(PermOverrideManager.ALLOWED | PermOverrideManager.DENIED);}
*
* <p><b>Flag Constants:</b>
* <ul>
* <li>{@link #DENIED}</li>
* <li>{@link #ALLOWED}</li>
* <li>{@link #PERMISSIONS}</li>
* </ul>
*
* @param fields
* Integer value containing the flags to reset.
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@Override
PermOverrideManager reset(long fields);
/**
* Resets the fields specified by the provided bit-flag patterns.
* You can specify a combination by using a bitwise OR concat of the flag constants.
* <br>Example: {@code manager.reset(PermOverrideManager.ALLOWED, PermOverrideManager.DENIED);}
*
* <p><b>Flag Constants:</b>
* <ul>
* <li>{@link #DENIED}</li>
* <li>{@link #ALLOWED}</li>
* <li>{@link #PERMISSIONS}</li>
* </ul>
*
* @param fields
* Integer values containing the flags to reset.
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@Override
PermOverrideManager reset(long... fields);
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} this Manager's
* {@link GuildChannel GuildChannel} is in.
* <br>This is logically the same as calling {@code getPermissionOverride().getGuild()}
*
* @return The parent {@link net.dv8tion.jda.api.entities.Guild Guild}
*/
@Nonnull
default Guild getGuild()
{
return getPermissionOverride().getGuild();
}
/**
* The {@link IPermissionContainer GuildChannel} this Manager's
* {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride} is in.
* <br>This is logically the same as calling {@code getPermissionOverride().getChannel()}
*
* @return The parent {@link GuildChannel GuildChannel}
*/
@Nonnull
default IPermissionContainerUnion getChannel()
{
return getPermissionOverride().getChannel();
}
/**
* The target {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
* that will be modified by this Manager
*
* @return The target {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*/
@Nonnull
PermissionOverride getPermissionOverride();
/**
* Grants the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to grant to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
PermOverrideManager grant(long permissions);
/**
* Grants the provided {@link net.dv8tion.jda.api.Permission Permissions}
* to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to grant to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see net.dv8tion.jda.api.Permission#getRaw(net.dv8tion.jda.api.Permission...) Permission.getRaw(Permission...)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager grant(@Nonnull Permission... permissions)
{
Checks.notNull(permissions, "Permissions");
return grant(Permission.getRaw(permissions));
}
/**
* Grants the provided {@link net.dv8tion.jda.api.Permission Permissions}
* to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to grant to the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.Permission#getRaw(java.util.Collection) Permission.getRaw(Collection)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager grant(@Nonnull Collection<Permission> permissions)
{
return grant(Permission.getRaw(permissions));
}
/**
* Denies the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to deny from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
PermOverrideManager deny(long permissions);
/**
* Denies the provided {@link net.dv8tion.jda.api.Permission Permissions}
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to deny from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see net.dv8tion.jda.api.Permission#getRaw(net.dv8tion.jda.api.Permission...) Permission.getRaw(Permission...)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager deny(@Nonnull Permission... permissions)
{
Checks.notNull(permissions, "Permissions");
return deny(Permission.getRaw(permissions));
}
/**
* Denies the provided {@link net.dv8tion.jda.api.Permission Permissions}
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* @param permissions
* The permissions to deny from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.Permission#getRaw(java.util.Collection) Permission.getRaw(Collection)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager deny(@Nonnull Collection<Permission> permissions)
{
return deny(Permission.getRaw(permissions));
}
/**
* Clears the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
* <br>This will cause the provided Permissions to be inherited
*
* @param permissions
* The permissions to clear from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
PermOverrideManager clear(long permissions);
/**
* Clears the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
* <br>This will cause the provided Permissions to be inherited
*
* @param permissions
* The permissions to clear from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager clear(@Nonnull Permission... permissions)
{
Checks.notNull(permissions, "Permissions");
return clear(Permission.getRaw(permissions));
}
/**
* Clears the provided {@link net.dv8tion.jda.api.Permission Permissions} bits
* from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
* <br>This will cause the provided Permissions to be inherited
*
* @param permissions
* The permissions to clear from the selected {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}
*
* @throws IllegalArgumentException
* If any of the provided Permissions is {@code null}
*
* @return PermOverrideManager for chaining convenience
*
* @see java.util.EnumSet EnumSet
* @see net.dv8tion.jda.api.Permission#getRaw(java.util.Collection) Permission.getRaw(Collection)
*/
@Nonnull
@CheckReturnValue
default PermOverrideManager clear(@Nonnull Collection<Permission> permissions)
{
return clear(Permission.getRaw(permissions));
}
}