added overloads to FreeChannelMonitor - might revert!

Author: interacsion

application/src/main/java/org/togetherjava/tjbot/commands/free/FreeChannelMonitor.java

@@ -97,6 +97,19 @@ public boolean isMonitoringChannel(final long channelId) {
         return channelsToMonitorById.containsKey(channelId);
     }
 
+    /**
+     * This method tests whether a channel id is configured for monitoring in the free command
+     * system. To add a channel for monitoring see
+     * {@link org.togetherjava.tjbot.config.FreeCommandConfig} or
+     * {@link #addChannelToMonitor(long)}.
+     *
+     * @param channel the channel to test.
+     * @return {@code true} if the channel is configured in the system, {@code false} otherwise.
+     */
+    public boolean isMonitoringChannel(@NotNull TextChannel channel) {
+        return isMonitoringChannel(channel.getIdLong());
+    }
+
     private ChannelStatus requiresIsMonitored(final long channelId) {
         if (!channelsToMonitorById.containsKey(channelId)) {
             throw new IllegalArgumentException(
@@ -117,6 +130,18 @@ public boolean isChannelBusy(final long channelId) {
         return requiresIsMonitored(channelId).isBusy();
     }
 
+    /**
+     * This method tests if channel status to busy, see {@link ChannelStatus#isBusy()} for details.
+     *
+     * @param channel the channel to test.
+     * @return {@code true} if the channel is 'busy', false if the channel is 'free'.
+     * @throws IllegalArgumentException if the channel passed is not monitored. See
+     *         {@link #addChannelToMonitor(long)}
+     */
+    public boolean isChannelBusy(@NotNull TextChannel channel) {
+        return isChannelBusy(channel.getIdLong());
+    }
+
     /**
      * This method tests if a channel is currently active by fetching the latest message and testing
      * if it was posted more recently than the configured time limit, see
@@ -170,6 +195,18 @@ public void setChannelFree(final long channelId) {
         requiresIsMonitored(channelId).setFree();
     }
 
+    /**
+     * This method sets the channel's status to 'free', see {@link ChannelStatus#setFree()} for
+     * details.
+     *
+     * @param channel the channel status to modify.
+     * @throws IllegalArgumentException if the channel passed is not monitored. See
+     *         {@link #addChannelToMonitor(long)}
+     */
+    public void setChannelFree(@NotNull TextChannel channel) {
+        setChannelFree(channel.getIdLong());
+    }
+
     /**
      * This method provides a stream of the id's for guilds that are currently being monitored. This
      * is streamed purely as a simple method of encapsulation.
@@ -338,6 +375,23 @@ public void displayStatus(@NotNull TextChannel channel) {
         }
     }
 
+    /**
+     * Displays the message that will be displayed for users.
+     * <p>
+     * This method detects if any messages have been posted in the channel below the status message.
+     * If that is the case this will delete the existing status message and post another one so that
+     * it's the last message in the channel.
+     * <p>
+     * If it cannot find an existing status message it will create a new one.
+     * <p>
+     * Otherwise it will edit the existing message.
+     *
+     * @param guild the guild the status message will be posted in.
+     */
+    public void displayStatus(@NotNull Guild guild) {
+        displayStatus(getStatusChannelFor(guild));
+    }
+
     private @NotNull Optional<Message> deleteIfNotLatest(@NotNull Message message) {
 
         OptionalLong lastId = FreeUtil.getLastMessageId(message.getTextChannel());

application/src/main/java/org/togetherjava/tjbot/commands/free/FreeHelpChannelsRoutine.java

@@ -34,14 +34,13 @@ public FreeHelpChannelsRoutine(@NotNull FreeChannelMonitor freeChannelMonitor) {
     public void runRoutine(@NotNull JDA jda) {
         jda.getTextChannels()
             .stream()
-            .filter(channel -> freeChannelMonitor.isMonitoringChannel(channel.getIdLong()))
-            .filter(channel -> freeChannelMonitor.isChannelBusy(channel.getIdLong()))
+            .filter(freeChannelMonitor::isMonitoringChannel)
+            .filter(freeChannelMonitor::isChannelBusy)
             .filter(channel -> TimeUtil.getTimeCreated(channel.getLatestMessageIdLong())
                 .isBefore(OffsetDateTime.now().minusMinutes(INACTIVE_TIME_MINUTES)))
             .forEach(channel -> {
-                freeChannelMonitor.setChannelFree(channel.getIdLong());
-                freeChannelMonitor
-                    .displayStatus(freeChannelMonitor.getStatusChannelFor(channel.getGuild()));
+                freeChannelMonitor.setChannelFree(channel);
+                freeChannelMonitor.displayStatus(channel.getGuild());
 
                 channel.sendMessage(
                         "This channel was automatically marked as free because it was inactive for more than 2 hours.")