/
CustomEmojiManager.java
149 lines (139 loc) · 4.71 KB
/
CustomEmojiManager.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
/*
* 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.entities.Guild;
import net.dv8tion.jda.api.entities.Role;
import net.dv8tion.jda.api.entities.emoji.RichCustomEmoji;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Set;
/**
* Manager providing functionality to update one or more fields for an {@link RichCustomEmoji}.
*
* <p><b>Example</b>
* <pre>{@code
* manager.setName("minn")
* .setRoles(null)
* .queue();
* manager.reset(CustomEmojiManager.NAME | CustomEmojiManager.ROLES)
* .setName("dv8")
* .setRoles(roles)
* .queue();
* }</pre>
*
* @see RichCustomEmoji#getManager()
*/
public interface CustomEmojiManager extends Manager<CustomEmojiManager>
{
/** Used to reset the name field */
long NAME = 1;
/** Used to reset the roles field */
long ROLES = 1 << 1;
/**
* 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(CustomEmojiManager.NAME | CustomEmojiManager.ROLES);}
*
* <p><b>Flag Constants:</b>
* <ul>
* <li>{@link #NAME}</li>
* <li>{@link #ROLES}</li>
* </ul>
*
* @param fields
* Integer value containing the flags to reset.
*
* @return CustomEmojiManager for chaining convenience
*/
@Nonnull
@Override
CustomEmojiManager reset(long fields);
/**
* Resets the fields specified by the provided bit-flag patterns.
* <br>Example: {@code manager.reset(CustomEmojiManager.NAME, CustomEmojiManager.ROLES);}
*
* <p><b>Flag Constants:</b>
* <ul>
* <li>{@link #NAME}</li>
* <li>{@link #ROLES}</li>
* </ul>
*
* @param fields
* Integer values containing the flags to reset.
*
* @return CustomEmojiManager for chaining convenience
*/
@Nonnull
@Override
CustomEmojiManager reset(long... fields);
/**
* The {@link net.dv8tion.jda.api.entities.Guild Guild} this Manager's
* {@link RichCustomEmoji} is in.
* <br>This is logically the same as calling {@code getEmoji().getGuild()}
*
* @return The parent {@link net.dv8tion.jda.api.entities.Guild Guild}
*/
@Nonnull
default Guild getGuild()
{
return getEmoji().getGuild();
}
/**
* The target {@link RichCustomEmoji} that will be modified by this Manager
*
* @return The target emoji
*/
@Nonnull
RichCustomEmoji getEmoji();
/**
* Sets the <b><u>name</u></b> of the selected {@link RichCustomEmoji}.
*
* <p>An emoji name <b>must</b> be between 2-32 characters long!
* <br>Emoji names may only be populated with alphanumeric (with underscore and dash).
*
* <p><b>Example</b>: {@code tatDab} or {@code fmgSUP}
*
* @param name
* The new name for the selected {@link RichCustomEmoji}
*
* @throws IllegalArgumentException
* If the provided name is {@code null} or not between 2-32 characters long
*
* @return CustomEmojiManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
CustomEmojiManager setName(@Nonnull String name);
/**
* Sets the <b><u>restriction roles</u></b> of the selected {@link RichCustomEmoji}.
* <br>If these are empty the emoji will be available to everyone otherwise only available to the specified roles.
*
* <p>An emoji's restriction roles <b>must not</b> contain {@code null}!
*
* @param roles
* The new set of {@link net.dv8tion.jda.api.entities.Role Roles} for the selected {@link RichCustomEmoji}
* to be restricted to, or {@code null} to clear the roles
*
* @throws IllegalArgumentException
* If any of the provided values is {@code null}
*
* @return CustomEmojiManager for chaining convenience
*/
@Nonnull
@CheckReturnValue
CustomEmojiManager setRoles(@Nullable Set<Role> roles);
}