From 52be987cbe4de562a9a342067c1c20cbdb804aca Mon Sep 17 00:00:00 2001 From: Click Date: Fri, 26 Aug 2022 18:36:29 -0500 Subject: [PATCH 1/3] Added documentation and private modifiers --- .../tjbot/commands/help/HelpSystemHelper.java | 3 ++- .../tjbot/commands/help/HelpThreadMetadataPurger.java | 5 +++++ .../commands/help/OnGuildLeaveCloseThreadListener.java | 9 +++++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java index 083a93c228..ff21cea6c6 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java @@ -56,6 +56,7 @@ public final class HelpSystemHelper { * Creates a new instance. * * @param config the config to use + * @param database the database to use */ public HelpSystemHelper(@NotNull Config config, @NotNull Database database) { HelpSystemConfig helpConfig = config.getHelpSystem(); @@ -104,7 +105,7 @@ RestAction sendExplanationMessage(@NotNull MessageChannel threadChannel return action.setEmbeds(embeds); } - public void writeHelpThreadToDatabase(Member author, ThreadChannel threadChannel) { + void writeHelpThreadToDatabase(Member author, ThreadChannel threadChannel) { database.write(content -> { HelpThreadsRecord helpThreadsRecord = content.newRecord(HelpThreads.HELP_THREADS) .setAuthorId(author.getIdLong()) diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java index 94333bf044..7e475df4a1 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java @@ -19,6 +19,11 @@ public class HelpThreadMetadataPurger implements Routine { private static final Logger logger = LoggerFactory.getLogger(HelpThreadMetadataPurger.class); private static final Period DELETE_MESSAGE_RECORDS_AFTER = Period.ofDays(30); + /** + * Creates a new instance + * + * @param database the database to use + */ public HelpThreadMetadataPurger(@NotNull Database database) { this.database = database; } diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java index 0fa1e72a74..742f8e2ced 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java @@ -23,6 +23,11 @@ public class OnGuildLeaveCloseThreadListener extends ListenerAdapter implements LoggerFactory.getLogger(OnGuildLeaveCloseThreadListener.class); private final Database database; + /** + * Creates a new instance + * + * @param database database to use + */ public OnGuildLeaveCloseThreadListener(@NotNull Database database) { this.database = database; } @@ -35,7 +40,7 @@ public void onGuildMemberRemove(@Nonnull GuildMemberRemoveEvent leaveEvent) { } } - public Set getThreadsCreatedByLeaver(long leaverId) { + private Set getThreadsCreatedByLeaver(long leaverId) { return new HashSet<>(database .readTransaction(context -> context.select(HelpThreads.HELP_THREADS.CHANNEL_ID)) .from(HelpThreads.HELP_THREADS) @@ -43,7 +48,7 @@ public Set getThreadsCreatedByLeaver(long leaverId) { .fetch(databaseMapper -> databaseMapper.getValue(HelpThreads.HELP_THREADS.CHANNEL_ID))); } - public void closeThread(long channelId, @NotNull GuildMemberRemoveEvent leaveEvent) { + private void closeThread(long channelId, @NotNull GuildMemberRemoveEvent leaveEvent) { ThreadChannel threadChannel = leaveEvent.getGuild().getThreadChannelById(channelId); if (threadChannel == null) { logger.warn( From 5e1516e05e6a23a6b9b8a68378daf35e7b002c19 Mon Sep 17 00:00:00 2001 From: Click Date: Fri, 26 Aug 2022 19:03:59 -0500 Subject: [PATCH 2/3] Added more clarity to ensure optimal agreement on the use cases of parameters. --- .../togetherjava/tjbot/commands/help/HelpSystemHelper.java | 2 +- .../tjbot/commands/help/HelpThreadMetadataPurger.java | 4 ++-- .../tjbot/commands/help/OnGuildLeaveCloseThreadListener.java | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java index ff21cea6c6..2cb70b07b2 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java @@ -56,7 +56,7 @@ public final class HelpSystemHelper { * Creates a new instance. * * @param config the config to use - * @param database the database to use + * @param database The database to store help thread metadata in. */ public HelpSystemHelper(@NotNull Config config, @NotNull Database database) { HelpSystemConfig helpConfig = config.getHelpSystem(); diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java index 7e475df4a1..129344a77b 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java @@ -20,9 +20,9 @@ public class HelpThreadMetadataPurger implements Routine { private static final Period DELETE_MESSAGE_RECORDS_AFTER = Period.ofDays(30); /** - * Creates a new instance + * Creates a new instance. * - * @param database the database to use + * @param database The database used to purge help thread metadata. */ public HelpThreadMetadataPurger(@NotNull Database database) { this.database = database; diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java index 742f8e2ced..4d8a945f5d 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/OnGuildLeaveCloseThreadListener.java @@ -24,7 +24,7 @@ public class OnGuildLeaveCloseThreadListener extends ListenerAdapter implements private final Database database; /** - * Creates a new instance + * Creates a new instance. * * @param database database to use */ From 34bad5c6b284890504d9e35b35f7e16fff617073 Mon Sep 17 00:00:00 2001 From: Click Date: Fri, 26 Aug 2022 19:06:37 -0500 Subject: [PATCH 3/3] Fixed period at the end of the parameter documentation --- .../org/togetherjava/tjbot/commands/help/HelpSystemHelper.java | 2 +- .../tjbot/commands/help/HelpThreadMetadataPurger.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java index 2cb70b07b2..c99cc119e4 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpSystemHelper.java @@ -56,7 +56,7 @@ public final class HelpSystemHelper { * Creates a new instance. * * @param config the config to use - * @param database The database to store help thread metadata in. + * @param database the database to store help thread metadata in */ public HelpSystemHelper(@NotNull Config config, @NotNull Database database) { HelpSystemConfig helpConfig = config.getHelpSystem(); diff --git a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java index 129344a77b..2fa502b76b 100644 --- a/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java +++ b/application/src/main/java/org/togetherjava/tjbot/commands/help/HelpThreadMetadataPurger.java @@ -22,7 +22,7 @@ public class HelpThreadMetadataPurger implements Routine { /** * Creates a new instance. * - * @param database The database used to purge help thread metadata. + * @param database the database used to purge help thread metadata */ public HelpThreadMetadataPurger(@NotNull Database database) { this.database = database;