From 6a41664fef4f81f2d8119d828dbba15df420bd7b Mon Sep 17 00:00:00 2001
From: EpicKnarvik97 <kristian.knarvik@knett.no>
Date: Fri, 7 Apr 2023 20:33:03 +0200
Subject: [PATCH] Adds some missing comments and annotations

---
 .../placeholder/DropperRecordExpansion.java   | 26 ++++++++++++++++---
 1 file changed, 22 insertions(+), 4 deletions(-)

diff --git a/src/main/java/net/knarcraft/dropper/placeholder/DropperRecordExpansion.java b/src/main/java/net/knarcraft/dropper/placeholder/DropperRecordExpansion.java
index ebadf69..3d69cc7 100644
--- a/src/main/java/net/knarcraft/dropper/placeholder/DropperRecordExpansion.java
+++ b/src/main/java/net/knarcraft/dropper/placeholder/DropperRecordExpansion.java
@@ -124,9 +124,9 @@ public class DropperRecordExpansion extends PlaceholderExpansion {
 
         ArenaRecord<?> record;
         if (recordType == RecordType.DEATHS) {
-            record = getDeathRecords(group, gameMode, recordNumber);
+            record = getGroupDeathRecord(group, gameMode, recordNumber);
         } else {
-            record = getTimeRecords(group, gameMode, recordNumber);
+            record = getGroupTimeRecord(group, gameMode, recordNumber);
         }
 
         // If a record number is not found, leave it blank, so it looks neat
@@ -137,12 +137,30 @@ public class DropperRecordExpansion extends PlaceholderExpansion {
         return getRecordData(infoType, record);
     }
 
-    private ArenaRecord<?> getTimeRecords(DropperArenaGroup group, ArenaGameMode gameMode, int recordNumber) {
+    /**
+     * Gets a time record from a group, using the cache if possible
+     *
+     * @param group        <p>The group to get the record from</p>
+     * @param gameMode     <p>The game-mode to get the record from</p>
+     * @param recordNumber <p>The placing of the record to get (1st place, 2nd place, etc.)</p>
+     * @return <p>The record, or null if not found</p>
+     */
+    private @Nullable ArenaRecord<?> getGroupTimeRecord(@NotNull DropperArenaGroup group,
+                                                        @NotNull ArenaGameMode gameMode, int recordNumber) {
         return getCachedGroupRecord(group, gameMode, RecordType.TIME, recordNumber, groupRecordTimeCache,
                 () -> DropperGroupRecordHelper.getCombinedTime(group, gameMode));
     }
 
-    private ArenaRecord<?> getDeathRecords(DropperArenaGroup group, ArenaGameMode gameMode, int recordNumber) {
+    /**
+     * Gets a death record from a group, using the cache if possible
+     *
+     * @param group        <p>The group to get the record from</p>
+     * @param gameMode     <p>The game-mode to get the record from</p>
+     * @param recordNumber <p>The placing of the record to get (1st place, 2nd place, etc.)</p>
+     * @return <p>The record, or null if not found</p>
+     */
+    private @Nullable ArenaRecord<?> getGroupDeathRecord(@NotNull DropperArenaGroup group,
+                                                         @NotNull ArenaGameMode gameMode, int recordNumber) {
         return getCachedGroupRecord(group, gameMode, RecordType.DEATHS, recordNumber, groupRecordDeathsCache,
                 () -> DropperGroupRecordHelper.getCombinedDeaths(group, gameMode));
     }