Added channel find methods to Guilds helper (findTextChannel etc)

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/features/help/HelpSystemHelper.java

@@ -361,11 +361,7 @@ Optional<ForumChannel> handleRequireHelpForum(Guild guild,
         Predicate<String> isChannelName = this::isHelpForumName;
         String channelPattern = getHelpForumPattern();
 
-        Optional<ForumChannel> maybeChannel = guild.getForumChannelCache()
-            .stream()
-            .filter(channel -> isChannelName.test(channel.getName()))
-            .findAny();
-
+        Optional<ForumChannel> maybeChannel = Guilds.findForumChannel(guild, isChannelName);
         if (maybeChannel.isEmpty()) {
             consumeChannelPatternIfNotFound.accept(channelPattern);
         }

application/src/main/java/org/togetherjava/tjbot/features/moderation/audit/ModAuditLogWriter.java

@@ -10,6 +10,7 @@
 import org.slf4j.LoggerFactory;
 
 import org.togetherjava.tjbot.config.Config;
+import org.togetherjava.tjbot.features.utils.Guilds;
 
 import javax.annotation.Nullable;
 
@@ -34,7 +35,7 @@ public final class ModAuditLogWriter {
 
     private final Config config;
 
-    private final Predicate<String> auditLogChannelNamePredicate;
+    private final Predicate<String> isAuditLogChannelName;
 
     /**
      * Creates a new instance.
@@ -43,7 +44,7 @@ public final class ModAuditLogWriter {
      */
     public ModAuditLogWriter(Config config) {
         this.config = config;
-        auditLogChannelNamePredicate =
+        isAuditLogChannelName =
                 Pattern.compile(config.getModAuditLogChannelPattern()).asMatchPredicate();
     }
 
@@ -90,11 +91,8 @@ public void write(String title, String description, @Nullable User author,
      * @return the channel used for moderation audit logs, if present
      */
     public Optional<TextChannel> getAndHandleModAuditLogChannel(Guild guild) {
-        Optional<TextChannel> auditLogChannel = guild.getTextChannelCache()
-            .stream()
-            .filter(channel -> auditLogChannelNamePredicate.test(channel.getName()))
-            .findAny();
-
+        Optional<TextChannel> auditLogChannel =
+                Guilds.findTextChannel(guild, isAuditLogChannelName);
         if (auditLogChannel.isEmpty()) {
             logger.warn(
                     "Unable to log moderation events, did not find a mod audit log channel matching the configured pattern '{}' for guild '{}'",

application/src/main/java/org/togetherjava/tjbot/features/moderation/scam/ScamBlocker.java

@@ -66,7 +66,7 @@ public final class ScamBlocker extends MessageReceiverAdapter implements UserInt
     private final ScamBlockerConfig.Mode mode;
     private final String reportChannelPattern;
     private final String botTrapChannelPattern;
-    private final Predicate<TextChannel> isReportChannel;
+    private final Predicate<String> isReportChannelName;
     private final Predicate<TextChannel> isBotTrapChannel;
     private final ScamDetector scamDetector;
     private final Config config;
@@ -92,9 +92,7 @@ public ScamBlocker(ModerationActionsStore actionsStore, ScamHistoryStore scamHis
         scamDetector = new ScamDetector(config);
 
         reportChannelPattern = config.getScamBlocker().getReportChannelPattern();
-        Predicate<String> isReportChannelName =
-                Pattern.compile(reportChannelPattern).asMatchPredicate();
-        isReportChannel = channel -> isReportChannelName.test(channel.getName());
+        isReportChannelName = Pattern.compile(reportChannelPattern).asMatchPredicate();
 
         botTrapChannelPattern = config.getScamBlocker().getBotTrapChannelPattern();
         Predicate<String> isBotTrapChannelName =
@@ -297,7 +295,7 @@ If you think this was a mistake (for example, your account was hacked, but you g
     }
 
     private Optional<TextChannel> getReportChannel(Guild guild) {
-        return guild.getTextChannelCache().stream().filter(isReportChannel).findAny();
+        return Guilds.findTextChannel(guild, isReportChannelName);
     }
 
     private List<Button> createConfirmDialog(MessageReceivedEvent event) {

application/src/main/java/org/togetherjava/tjbot/features/tophelper/TopHelpersAssignmentRoutine.java

@@ -131,10 +131,8 @@ private static boolean isFirstDayOfMonth() {
      * @param guild to start the dialog and compute Top Helpers for
      */
     public void startDialogFor(Guild guild) {
-        Optional<TextChannel> assignmentChannel = guild.getTextChannelCache()
-            .stream()
-            .filter(channel -> assignmentChannelNamePredicate.test(channel.getName()))
-            .findAny();
+        Optional<TextChannel> assignmentChannel =
+                Guilds.findTextChannel(guild, assignmentChannelNamePredicate);
 
         assignmentChannel.ifPresentOrElse(this::startDialogIn, () -> logger.warn(
                 "Unable to assign Top Helpers, did not find an assignment channel matching the configured pattern '{}' for guild '{}'",
@@ -313,10 +311,8 @@ private void prepareAnnouncement(ButtonInteractionEvent event, List<String> args
 
     private void postAnnouncement(ButtonInteractionEvent event, List<? extends Member> topHelpers) {
         Guild guild = Objects.requireNonNull(event.getGuild());
-        Optional<TextChannel> announcementChannel = guild.getTextChannelCache()
-            .stream()
-            .filter(channel -> announcementChannelNamePredicate.test(channel.getName()))
-            .findAny();
+        Optional<TextChannel> announcementChannel =
+                Guilds.findTextChannel(guild, announcementChannelNamePredicate);
 
         if (announcementChannel.isEmpty()) {
             logger.warn(

application/src/main/java/org/togetherjava/tjbot/features/utils/Guilds.java

@@ -3,6 +3,10 @@
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.Member;
 import net.dv8tion.jda.api.entities.Role;
+import net.dv8tion.jda.api.entities.channel.attribute.IGuildChannelContainer;
+import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
+import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
+import net.dv8tion.jda.api.entities.channel.middleman.GuildChannel;
 
 import java.util.Optional;
 import java.util.function.Predicate;
@@ -53,4 +57,34 @@ public static boolean doesMemberNotHaveRole(Member member,
             Predicate<? super String> isRoleName) {
         return member.getRoles().stream().map(Role::getName).noneMatch(isRoleName);
     }
+
+    /**
+     * Finds any text channel in the guild whose name matches the given predicate.
+     *
+     * @param guild guild to search the channel in
+     * @param isChannelName a predicate matching the name of the text channel to search
+     * @return the matched text channel, if any
+     */
+    public static Optional<TextChannel> findTextChannel(IGuildChannelContainer<GuildChannel> guild,
+            Predicate<? super String> isChannelName) {
+        return guild.getTextChannelCache()
+            .stream()
+            .filter(channel -> isChannelName.test(channel.getName()))
+            .findAny();
+    }
+
+    /**
+     * Finds any forum channel in the guild whose name matches the given predicate.
+     *
+     * @param guild guild to search the channel in
+     * @param isChannelName a predicate matching the name of the forum channel to search
+     * @return the matched forum channel, if any
+     */
+    public static Optional<ForumChannel> findForumChannel(
+            IGuildChannelContainer<GuildChannel> guild, Predicate<? super String> isChannelName) {
+        return guild.getForumChannelCache()
+            .stream()
+            .filter(channel -> isChannelName.test(channel.getName()))
+            .findAny();
+    }
 }