Add Javadocs

Author: Jsinco

main/src/main/java/net/citizensnpcs/trait/scoreboard/AbstractScoreboard.java

@@ -1,10 +1,30 @@
 package net.citizensnpcs.trait.scoreboard;
 
+/**
+ * Represents a scoreboard that can be used to manage teams and their entries.
+ * This is an abstraction over the underlying {@link org.bukkit.scoreboard.Scoreboard} and
+ * {@link net.megavex.scoreboardlibrary.api.team.ScoreboardTeam} objects.
+ */
 public interface AbstractScoreboard {
 
+    /**
+     * Gets a team by name.
+     * @param name Name of the team.
+     * @return Team with the given name, or null if no such team exists.
+     */
     AbstractTeam getTeam(String name);
 
+    /**
+     * Deletes a team from this scoreboard.
+     * @param name Name of the team.
+     */
     void removeTeam(String name);
 
+
+    /**
+     * Creates a new team if it does not exist.
+     * @param name Name of the team.
+     * @return Team with the given name, or the existing team if it already exists.
+     */
     AbstractTeam createTeam(String name);
 }

main/src/main/java/net/citizensnpcs/trait/scoreboard/AbstractTeam.java

@@ -5,46 +5,145 @@
 import org.bukkit.entity.Player;
 import org.bukkit.scoreboard.Team;
 
+
+/**
+ * Represents a team that can be used to manage entries and their display properties.
+ * This is an abstraction over the underlying {@link Team} and {@link net.megavex.scoreboardlibrary.api.team.ScoreboardTeam} objects.
+ * Entries can be either player display names (usernames) or entity UUIDs represented as strings.
+ */
 public interface AbstractTeam {
 
+    /**
+     * Adds an entry to the team.
+     * For players, this should be their display name (username).
+     * For entities, this should be their UUID represented as a string.
+     *
+     * @param entry Entry to add.
+     */
     void addEntry(String entry);
 
+    /**
+     * Checks if the team has an entry.
+     * For players, this should be their display name (username).
+     * For entities, this should be their UUID represented as a string.
+     *
+     * @param entry Entry to check.
+     * @return True if the team has the entry, false otherwise.
+     */
     boolean hasEntry(String entry);
 
+    /**
+     * Removes an entry from the team.
+     * For players, this should be their display name (username).
+     * For entities, this should be their UUID represented as a string.
+     *
+     * @param entry Entry to remove.
+     */
     void removeEntry(String entry);
 
+    /**
+     * Gets the color of the team.
+     * @return The color of the team.
+     */
     ChatColor getColor();
 
+    /**
+     * Gets the name tag visibility of the team.
+     * @return The name tag visibility of the team.
+     */
     NameTags getNameTagVisibility();
 
+    /**
+     * Gets the collision rule of the team.
+     * @return The collision rule of the team.
+     */
     CollisionRule getCollisionRule();
 
+    /**
+     * Sets the color of the team.
+     * @param color The color of the team.
+     */
     void setColor(ChatColor color);
 
+    /**
+     * Sets the name tag visibility of the team.
+     * @param visibility The name tag visibility of the team.
+     */
     void setNameTagVisibility(NameTags visibility);
 
+    /**
+     * Sets the collision rule of the team.
+     * @param rule The collision rule of the team.
+     */
     void setCollisionRule(CollisionRule rule);
 
+    /**
+     * Gets the underlying delegate object.
+     * This may either be a {@link Team} or {@link net.megavex.scoreboardlibrary.api.team.ScoreboardTeam}
+     * @return The underlying delegate object.
+     */
     Object getDelegate();
 
+    /**
+     * Gets the name of the team.
+     * @return The name of the team.
+     */
     String getName();
 
+    /**
+     * Sends the team to a player.
+     * @param player Player to send to.
+     * @param mode Send mode.
+     */
     void sendToPlayer(Player player, SendMode mode);
 
+    /**
+     * Gets the number of entries in the team.
+     * @return The number of entries in the team.
+     */
     int getSize();
 
 
+    /**
+     * Interface for team options that can be represented as both a packet-based value and a Bukkit value.
+     * @param <P> Packet-based (folia) value type.
+     */
     interface TeamOption<P> {
+
+        /**
+         * Gets the packet-based (folia) value of this option.
+         * @return The packet-based (folia) value of this option.
+         */
         P getFoliaValue();
+
+        /**
+         * Gets the Bukkit value of this option.
+         * @return The Bukkit value of this option.
+         */
         Team.OptionStatus getBukkitValue();
 
-        static <E extends TeamOption<P>, P> E fromPacket(E[] values, P packetValue) {
+        /**
+         * Utility method to convert from a packet-based (folia) value to the corresponding enum constant.
+         * @param values Array of enum constants.
+         * @param foliaValue Packet-based (folia) value to convert.
+         * @return The corresponding enum constant.
+         * @param <E> Enum type.
+         * @param <P> Packet-based (folia) value type.
+         */
+        static <E extends TeamOption<P>, P> E fromFolia(E[] values, P foliaValue) {
             for (E e : values) {
-                if (e.getFoliaValue().equals(packetValue)) return e;
+                if (e.getFoliaValue().equals(foliaValue)) return e;
             }
             return values[0];
         }
 
+        /**
+         * Utility method to convert from a Bukkit value to the corresponding enum constant.
+         * @param values Array of enum constants.
+         * @param bukkitValue Bukkit value to convert.
+         * @return The corresponding enum constant.
+         * @param <E> Enum type.
+         */
         static <E extends TeamOption<?>> E fromBukkit(E[] values, Team.OptionStatus bukkitValue) {
             for (E e : values) {
                 if (e.getBukkitValue() == bukkitValue) return e;
@@ -53,6 +152,9 @@ static <E extends TeamOption<?>> E fromBukkit(E[] values, Team.OptionStatus bukk
         }
     }
 
+    /**
+     * Enum representing name tag visibility options.
+     */
     enum NameTags implements TeamOption<NameTagVisibility> {
         ALWAYS_SHOW(NameTagVisibility.ALWAYS, Team.OptionStatus.ALWAYS),
         NEVER_SHOW(NameTagVisibility.NEVER, Team.OptionStatus.NEVER),
@@ -67,26 +169,41 @@ enum NameTags implements TeamOption<NameTagVisibility> {
             this.bukkitValue = bukkitValue;
         }
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public NameTagVisibility getFoliaValue() {
             return packetBasedValue;
         }
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public Team.OptionStatus getBukkitValue() {
             return bukkitValue;
         }
 
+        /**
+         * @see #fromPacket(NameTagVisibility)
+         */
         public static NameTags fromPacket(NameTagVisibility value) {
-            return TeamOption.fromPacket(values(), value);
+            return TeamOption.fromFolia(values(), value);
         }
 
+        /**
+         * @see #fromBukkit(Team.OptionStatus)
+         */
         public static NameTags fromBukkit(Team.OptionStatus value) {
             return TeamOption.fromBukkit(values(), value);
         }
     }
 
 
+    /**
+     * Enum representing collision rule options.
+     */
     enum CollisionRule implements TeamOption<net.megavex.scoreboardlibrary.api.team.enums.CollisionRule> {
         ALWAYS(net.megavex.scoreboardlibrary.api.team.enums.CollisionRule.ALWAYS, Team.OptionStatus.ALWAYS),
         NEVER(net.megavex.scoreboardlibrary.api.team.enums.CollisionRule.NEVER, Team.OptionStatus.NEVER),
@@ -101,25 +218,40 @@ enum CollisionRule implements TeamOption<net.megavex.scoreboardlibrary.api.team.
             this.bukkitValue = bukkitValue;
         }
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public net.megavex.scoreboardlibrary.api.team.enums.CollisionRule getFoliaValue() {
             return packetBasedValue;
         }
 
+        /**
+         * {@inheritDoc}
+         */
         @Override
         public Team.OptionStatus getBukkitValue() {
             return bukkitValue;
         }
 
+        /**
+         * @see #fromBukkit(Team.OptionStatus)
+         */
         public static CollisionRule fromPacket(net.megavex.scoreboardlibrary.api.team.enums.CollisionRule value) {
-            return TeamOption.fromPacket(values(), value);
+            return TeamOption.fromFolia(values(), value);
         }
 
+        /**
+         * @see #fromBukkit(Team.OptionStatus)
+         */
         public static CollisionRule fromBukkit(Team.OptionStatus value) {
             return TeamOption.fromBukkit(values(), value);
         }
     }
 
+    /**
+     * Enum representing send modes.
+     */
     enum SendMode {
         ADD_OR_MODIFY(0),
         REMOVE(1);

main/src/main/java/net/citizensnpcs/trait/scoreboard/BukkitScoreboardImpl.java

@@ -8,7 +8,11 @@
 public class BukkitScoreboardImpl implements AbstractScoreboard {
 
 
-    Scoreboard scoreboard = Util.getDummyScoreboard();
+    private final Scoreboard scoreboard;
+
+    public BukkitScoreboardImpl() {
+        this.scoreboard = Util.getDummyScoreboard();
+    }
 
     @Nullable
     @Override

main/src/main/java/net/citizensnpcs/trait/scoreboard/FoliaTeamImpl.java

@@ -86,7 +86,7 @@ public int getSize() {
 
     @Override
     public void sendToPlayer(Player player, SendMode mode) {
-        // no-op
+        // TODO: Currently not implemented
         /*if (mode == SendMode.ADD_OR_MODIFY) {
             delegateDisplay.refresh();
             delegateTeam.display(player, delegateDisplay);