chore: add Javadoc strings to all public methods

Author: TropicalShadow

src/main/java/net/bridgesplash/sidebar/sidebar/SidebarManager.java

@@ -2,15 +2,27 @@
 
 import java.util.WeakHashMap;
 import net.minestom.server.entity.Player;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Manages the sidebar instances.
  */
-public class SidebarManager {
-
+public final class SidebarManager {
 
     private final WeakHashMap<Player, CustomSidebar> sidebars = new WeakHashMap<>();
 
+    /**
+     * Constructs a new SidebarManager.
+     */
+    public SidebarManager() {
+    }
+
+    /**
+     * Adds a sidebar for the given player.
+     *
+     * @param player Player to add
+     * @param sidebar Sidebar to register player with
+     */
     public void addSidebar(Player player, CustomSidebar sidebar) {
         sidebars.put(player, sidebar);
         sidebar.addViewer(player);
@@ -20,7 +32,6 @@ public void addSidebar(Player player, CustomSidebar sidebar) {
      * Removes the sidebar for the given player.
      *
      * @param player the player to remove the sidebar for.
-     *
      */
     public void removeSidebar(Player player) {
         CustomSidebar sidebar = sidebars.remove(player);
@@ -29,6 +40,13 @@ public void removeSidebar(Player player) {
         }
     }
 
+    /**
+     * Gets the sidebar for the given player.
+     *
+     * @param player player to get sidebar for
+     * @return CustomSidebar sidebar if it exists, null otherwise
+     */
+    @Nullable
     public CustomSidebar getSidebar(Player player) {
         return sidebars.get(player);
     }

src/main/java/net/bridgesplash/sidebar/state/Hooks.java

@@ -6,7 +6,11 @@
  * Utility class providing hook-like functions for managing
  * side effects in response to state changes.
  */
-public class Hooks {
+public final class Hooks {
+
+    private Hooks() {
+        throw new IllegalStateException("Utility class");
+    }
 
     /**
      * Runs the given effect whenever any of the specified dependencies change.

src/main/java/net/bridgesplash/sidebar/state/Memos.java

@@ -7,6 +7,10 @@
  */
 public final class Memos {
 
+    private Memos() {
+        throw new IllegalStateException("Utility class");
+    }
+
     /**
      * Returns a memoized {@link State} whose value is recomputed whenever any dependency changes.
      *

src/main/java/net/bridgesplash/sidebar/state/State.java

@@ -52,6 +52,11 @@ public void set(T newValue) {
         }
     }
 
+    /**
+     * Utility method to update the current value, given the previous value.
+     *
+     * @param update Function that takes the previous value and returns the new value
+     */
     public void setPrev(Function<T, T> update) {
         set(update.apply(get()));
     }

src/main/java/net/bridgesplash/sidebar/state/StateManager.java

@@ -2,6 +2,7 @@
 
 import java.util.concurrent.ConcurrentHashMap;
 import net.bridgesplash.sidebar.sidebar.CustomSidebar;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Manages the state instances.
@@ -12,14 +13,32 @@ public final class StateManager {
     private final ConcurrentHashMap<String, State<?>> states = new ConcurrentHashMap<>();
     private final CustomSidebar sidebar;
 
+    /**
+     * Constructs a new StateManager for the given sidebar.
+     *
+     * @param sidebar A sidebar to connect the state to
+     */
     public StateManager(CustomSidebar sidebar) {
         this.sidebar = sidebar;
     }
 
+    /**
+     * Gets the state for the given key.
+     *
+     * @param key The unique key for the state
+     * @return The state if it exists, null otherwise
+     */
+    @Nullable
     public State<?> getState(String key) {
         return states.get(key);
     }
 
+    /**
+     * Adds a state to the manager.
+     *
+     * @param key The unique key for the state
+     * @param state State of any type
+     */
     public void putState(String key, State<?> state) {
         states.put(key, state);
     }

src/main/java/net/bridgesplash/sidebar/state/types/CustomType.java

@@ -9,6 +9,10 @@
  */
 public final class AdventureUtils {
 
+    private AdventureUtils() {
+        throw new IllegalStateException("Utility class");
+    }
+
     /**
      * Converts an object to a {@link Component} for rendering.
      * Supports String, primitives, Component, ComponentLike, and falls back to toString().