Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Message interface declutter: Message#getMentions() (#2015)
* Reworked mentions into Message#getMentions * Add interaction mentions * Cleanup EntityBuilder#createMessage0 * Make use of UserSnowflake and fix bags * Improve getMentions and isMentioned code * Added type-specific getChannels getters
- Loading branch information
1 parent
c11cec4
commit 728b45e
Showing
13 changed files
with
1,292 additions
and
1,139 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
365 changes: 365 additions & 0 deletions
365
src/main/java/net/dv8tion/jda/api/entities/Mentions.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,365 @@ | ||
| /* | ||
| * 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.entities; | ||
|
|
||
| import net.dv8tion.jda.api.JDA; | ||
| import org.apache.commons.collections4.Bag; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Interface to access the mentions of various entities. | ||
| */ | ||
| public interface Mentions | ||
| { | ||
| /** | ||
| * The corresponding JDA instance | ||
| * | ||
| * @return The jda instance | ||
| */ | ||
| @Nonnull | ||
| JDA getJDA(); | ||
|
|
||
| /** | ||
| * Indicates if everyone is mentioned, by either using {@code @everyone} or {@code @here}. | ||
| * | ||
| * <p>This is different from checking if {@code @everyone} is in the string, since mentions require additional flags to trigger. | ||
| * | ||
| * @return True, if everyone is mentioned | ||
| */ | ||
| boolean mentionsEveryone(); | ||
|
|
||
| /** | ||
| * An immutable list of all mentioned {@link net.dv8tion.jda.api.entities.User Users}. | ||
| * <br>If no user was mentioned, this list is empty. Elements are sorted in order of appearance. This only | ||
| * counts direct mentions of the user and not mentions through roles or everyone mentions. | ||
| * | ||
| * <p>This might also contain users which are not present in {@link #getMembers()}. | ||
| * | ||
| * @return Immutable list of mentioned users | ||
| */ | ||
| @Nonnull | ||
| List<User> getUsers(); | ||
|
|
||
| /** | ||
| * A {@link org.apache.commons.collections4.Bag Bag} of mentioned {@link net.dv8tion.jda.api.entities.User Users}. | ||
| * <br>This can be used to retrieve the amount of times a user was mentioned. This only | ||
| * counts direct mentions of the user and not mentions through roles or everyone mentions. | ||
| * | ||
| * <p>This might also contain users which are not present in {@link #getMembers()}. | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * void sendCount(Message msg) | ||
| * { | ||
| * List<User> mentions = msg.getMentions().getUsers(); // distinct list, in order of appearance | ||
| * Bag<User> count = msg.getMentions().getUsersBag(); | ||
| * StringBuilder content = new StringBuilder(); | ||
| * for (User user : mentions) | ||
| * { | ||
| * content.append(user.getAsTag()) | ||
| * .append(": ") | ||
| * .append(count.getCount(user)) | ||
| * .append("\n"); | ||
| * } | ||
| * msg.getChannel().sendMessage(content.toString()).queue(); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @return {@link org.apache.commons.collections4.Bag Bag} of mentioned users | ||
| * | ||
| * @see #getUsers() | ||
| */ | ||
| @Nonnull | ||
| Bag<User> getUsersBag(); | ||
|
|
||
| /** | ||
| * An immutable list of all mentioned {@link net.dv8tion.jda.api.entities.GuildChannel GuildChannels}. | ||
| * <br>If none were mentioned, this list is empty. Elements are sorted in order of appearance. | ||
| * | ||
| * <p><b>This may include GuildChannels from other {@link net.dv8tion.jda.api.entities.Guild Guilds}</b> | ||
| * | ||
| * @return Immutable list of mentioned GuildChannels | ||
| */ | ||
| @Nonnull | ||
| List<GuildChannel> getChannels(); | ||
|
|
||
| /** | ||
| * A {@link org.apache.commons.collections4.Bag Bag} of mentioned channels. | ||
| * <br>This can be used to retrieve the amount of times a channel was mentioned. | ||
| * | ||
| * <p><b>This may include GuildChannels from other {@link net.dv8tion.jda.api.entities.Guild Guilds}</b> | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * void sendCount(Message msg) | ||
| * { | ||
| * Bag<GuildChannel> mentions = msg.getMentions().getChannelsBag(); | ||
| * StringBuilder content = new StringBuilder(); | ||
| * for (GuildChannel channel : mentions.uniqueSet()) | ||
| * { | ||
| * content.append("#") | ||
| * .append(channel.getName()) | ||
| * .append(": ") | ||
| * .append(mentions.getCount(channel)) | ||
| * .append("\n"); | ||
| * } | ||
| * msg.getChannel().sendMessage(content.toString()).queue(); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @return {@link org.apache.commons.collections4.Bag Bag} of mentioned channels | ||
| * | ||
| * @see #getChannels() | ||
| */ | ||
| @Nonnull | ||
| Bag<GuildChannel> getChannelsBag(); | ||
|
|
||
| /** | ||
| * An immutable list of all mentioned {@link net.dv8tion.jda.api.entities.GuildChannel GuildChannels} of type {@code clazz}. | ||
| * <br>If none were mentioned, this list is empty. Elements are sorted in order of appearance. | ||
| * | ||
| * <p><b>This may include GuildChannels from other {@link net.dv8tion.jda.api.entities.Guild Guilds}</b> | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * List<GuildMessageChannel> getCoolMessageChannels(Message msg) | ||
| * { | ||
| * List<GuildMessageChannel> channels = msg.getMentions().getChannels(GuildMessageChannel.class); | ||
| * return channels.stream() | ||
| * .filter(channel -> channel.getName().contains("cool")) | ||
| * .collect(Collectors.toList()); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @param clazz | ||
| * The {@link GuildChannel} sub-class {@link Class class object} of the type of channel desired | ||
| * | ||
| * @throws java.lang.IllegalArgumentException | ||
| * If {@code clazz} is {@code null} | ||
| * | ||
| * @return Immutable list of mentioned GuildChannels that are of type {@code clazz}. | ||
| */ | ||
| @Nonnull | ||
| <T extends GuildChannel> List<T> getChannels(@Nonnull Class<T> clazz); | ||
|
|
||
| /** | ||
| * A {@link org.apache.commons.collections4.Bag Bag} of mentioned channels of type {@code clazz}. | ||
| * <br>This can be used to retrieve the amount of times a channel was mentioned. | ||
| * | ||
| * <p><b>This may include GuildChannels from other {@link net.dv8tion.jda.api.entities.Guild Guilds}</b> | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * void sendCount(Message msg) | ||
| * { | ||
| * Bag<GuildMessageChannel> mentions = msg.getMentions().getChannelsBag(GuildMessageChannel.class); | ||
| * StringBuilder content = new StringBuilder(); | ||
| * for (GuildMessageChannel channel : mentions.uniqueSet()) | ||
| * { | ||
| * content.append("#") | ||
| * .append(channel.getName()) | ||
| * .append(": ") | ||
| * .append(mentions.getCount(channel)) | ||
| * .append("\n"); | ||
| * } | ||
| * msg.getChannel().sendMessage(content.toString()).queue(); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @param clazz | ||
| * The {@link GuildChannel} sub-class {@link Class class object} of the type of channel desired | ||
| * | ||
| * @throws java.lang.IllegalArgumentException | ||
| * If {@code clazz} is {@code null} | ||
| * | ||
| * @return {@link org.apache.commons.collections4.Bag Bag} of mentioned channels of type {@code clazz} | ||
| * | ||
| * @see #getChannels(Class) | ||
| */ | ||
| @Nonnull | ||
| <T extends GuildChannel> Bag<T> getChannelsBag(@Nonnull Class<T> clazz); | ||
|
|
||
| /** | ||
| * An immutable list of all mentioned {@link net.dv8tion.jda.api.entities.Role Roles}. | ||
| * <br>If none were mentioned, this list is empty. Elements are sorted in order of appearance. This only | ||
| * counts direct mentions of the role and not mentions through everyone mentions. | ||
| * | ||
| * <p><b>This may include Roles from other {@link net.dv8tion.jda.api.entities.Guild Guilds}</b> | ||
| * | ||
| * @return immutable list of mentioned Roles | ||
| */ | ||
| @Nonnull | ||
| List<Role> getRoles(); | ||
|
|
||
| /** | ||
| * A {@link org.apache.commons.collections4.Bag Bag} of mentioned roles. | ||
| * <br>This can be used to retrieve the amount of times a role was mentioned. This only | ||
| * counts direct mentions of the role and not mentions through everyone mentions. | ||
| * | ||
| * <p><b>This may include Roles from other {@link net.dv8tion.jda.api.entities.Guild Guilds}</b> | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * void sendCount(Message msg) | ||
| * { | ||
| * List<Role> mentions = msg.getMentions().getRoles(); // distinct list, in order of appearance | ||
| * Bag<Role> count = msg.getMentions().getRolesBag(); | ||
| * StringBuilder content = new StringBuilder(); | ||
| * for (Role role : mentions) | ||
| * { | ||
| * content.append(role.getName()) | ||
| * .append(": ") | ||
| * .append(count.getCount(role)) | ||
| * .append("\n"); | ||
| * } | ||
| * msg.getChannel().sendMessage(content.toString()).queue(); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @return {@link org.apache.commons.collections4.Bag Bag} of mentioned roles | ||
| * | ||
| * @see #getRoles() | ||
| */ | ||
| @Nonnull | ||
| Bag<Role> getRolesBag(); | ||
|
|
||
| /** | ||
| * All {@link net.dv8tion.jda.api.entities.Emote Emotes} used. | ||
| * <br><b>This only includes Custom Emotes, not unicode Emojis.</b> JDA classifies Emotes as the Custom Emojis uploaded | ||
| * to a Guild and retrievable with {@link net.dv8tion.jda.api.entities.Guild#getEmotes()}. These are not the same | ||
| * as the unicode emojis that Discord also supports. Elements are sorted in order of appearance. | ||
| * | ||
| * <p><b><u>Unicode emojis are not included as {@link net.dv8tion.jda.api.entities.Emote Emote}!</u></b> | ||
| * | ||
| * @return An immutable list of the Emotes used (example match {@literal <:jda:230988580904763393>}) | ||
| */ | ||
| @Nonnull | ||
| List<Emote> getEmotes(); | ||
|
|
||
| /** | ||
| * A {@link org.apache.commons.collections4.Bag Bag} of emotes used. | ||
| * <br>This can be used to retrieve the amount of times an emote was used. | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * void sendCount(Message msg) | ||
| * { | ||
| * List<Emote> emotes = msg.getMentions().getEmotes(); // distinct list, in order of appearance | ||
| * Bag<Emote> count = msg.getMentions().getEmotesBag(); | ||
| * StringBuilder content = new StringBuilder(); | ||
| * for (Emote emote : emotes) | ||
| * { | ||
| * content.append(emote.getName()) | ||
| * .append(": ") | ||
| * .append(count.getCount(role)) | ||
| * .append("\n"); | ||
| * } | ||
| * msg.getChannel().sendMessage(content.toString()).queue(); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @return {@link org.apache.commons.collections4.Bag Bag} of used emotes | ||
| * | ||
| * @see #getEmotes() | ||
| */ | ||
| @Nonnull | ||
| Bag<Emote> getEmotesBag(); | ||
|
|
||
| /** | ||
| * An immutable list of all mentioned {@link net.dv8tion.jda.api.entities.Member Members}. | ||
| * <br>If none were mentioned, this list is empty. Elements are sorted in order of appearance. This only | ||
| * counts direct mentions of the role and not mentions through everyone mentions. | ||
| * | ||
| * <p>This is always empty in {@link PrivateChannel PrivateChannels}. | ||
| * | ||
| * @return Immutable list of mentioned Members, or an empty list | ||
| */ | ||
| @Nonnull | ||
| List<Member> getMembers(); | ||
|
|
||
| /** | ||
| * A {@link org.apache.commons.collections4.Bag Bag} of mentioned {@link net.dv8tion.jda.api.entities.Member Members}. | ||
| * <br>This can be used to retrieve the amount of times a user was mentioned. This only | ||
| * counts direct mentions of the member and not mentions through roles or everyone mentions. | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * void sendCount(Message msg) | ||
| * { | ||
| * List<Member> mentions = msg.getMentions().getMembers(); // distinct list, in order of appearance | ||
| * Bag<Member> count = msg.getMentions().getMembersBag(); | ||
| * StringBuilder content = new StringBuilder(); | ||
| * for (Member user : mentions) | ||
| * { | ||
| * content.append(member.getUser().getAsTag()) | ||
| * .append(": ") | ||
| * .append(count.getCount(member)) | ||
| * .append("\n"); | ||
| * } | ||
| * msg.getChannel().sendMessage(content.toString()).queue(); | ||
| * } | ||
| * }</pre> | ||
| * | ||
| * @return {@link org.apache.commons.collections4.Bag Bag} of mentioned members | ||
| * | ||
| * @see #getMembers() | ||
| */ | ||
| @Nonnull | ||
| Bag<Member> getMembersBag(); | ||
|
|
||
| /** | ||
| * Combines all instances of {@link net.dv8tion.jda.api.entities.IMentionable IMentionable} | ||
| * filtered by the specified {@link net.dv8tion.jda.api.entities.Message.MentionType MentionType} values. | ||
| * <br>If a {@link Member} is available, it will be taken in favor of a {@link User}. | ||
| * This only provides either the Member or the User instance, rather than both. | ||
| * | ||
| * <p>If no MentionType values are given, all types are used. | ||
| * | ||
| * @param types | ||
| * {@link net.dv8tion.jda.api.entities.Message.MentionType MentionTypes} to include | ||
| * | ||
| * @throws java.lang.IllegalArgumentException | ||
| * If provided with {@code null} | ||
| * | ||
| * @return Immutable list of filtered {@link net.dv8tion.jda.api.entities.IMentionable IMentionable} instances | ||
| */ | ||
| @Nonnull | ||
| List<IMentionable> getMentions(@Nonnull Message.MentionType... types); | ||
|
|
||
| /** | ||
| * Checks if given {@link net.dv8tion.jda.api.entities.IMentionable IMentionable} | ||
| * was mentioned in any way (@User, @everyone, @here, @Role). | ||
| * <br>If no filtering {@link net.dv8tion.jda.api.entities.Message.MentionType MentionTypes} are | ||
| * specified, all types are used. | ||
| * | ||
| * <p>{@link Message.MentionType#HERE MentionType.HERE} and {@link Message.MentionType#EVERYONE MentionType.EVERYONE} | ||
| * will only be checked, if the given {@link net.dv8tion.jda.api.entities.IMentionable IMentionable} is of type | ||
| * {@link net.dv8tion.jda.api.entities.User User} or {@link net.dv8tion.jda.api.entities.Member Member}. | ||
| * <br>Online status of Users/Members is <b>NOT</b> considered when checking {@link Message.MentionType#HERE MentionType.HERE}. | ||
| * | ||
| * @param mentionable | ||
| * The mentionable entity to check on. | ||
| * @param types | ||
| * The types to include when checking whether this type was mentioned. | ||
| * This will be used with {@link #getMentions(Message.MentionType...) getMentions(MentionType...)} | ||
| * | ||
| * @return True, if the given mentionable was mentioned in this message | ||
| */ | ||
| boolean isMentioned(@Nonnull IMentionable mentionable, @Nonnull Message.MentionType... types); | ||
| } |
Oops, something went wrong.