Map API cleanup

src/main/java/net/minestom/server/advancements/notifications/NotificationCenter.java

@@ -21,11 +21,17 @@ public class NotificationCenter {
     private static final String IDENTIFIER = "minestom:notification";
 
     /**
-     * Can't create an instance
+     * Can't create an instance, use the static methods instead.
      */
     private NotificationCenter() {
     }
 
+    /**
+     * Send a {@link Notification} to one player.
+     *
+     * @param notification the {@link Notification} to send
+     * @param player       the player to send the notification to
+     */
     public static void send(Notification notification, Player player) {
         final PlayerConnection playerConnection = player.getPlayerConnection();
 
@@ -34,6 +40,12 @@ public class NotificationCenter {
         playerConnection.sendPacket(AdvancementUtils.getRemovePacket(new String[]{IDENTIFIER}));
     }
 
+    /**
+     * Send a {@link Notification} to a collection of players.
+     *
+     * @param notification the {@link Notification} to send
+     * @param players      the collection of players to send the notification to
+     */
     public static void send(Notification notification, Collection<Player> players) {
         // Can't use PacketWriterUtils before we need the packets to come in the correct order
         players.forEach(player -> {
@@ -42,7 +54,7 @@ public class NotificationCenter {
     }
 
     /**
-     * Create the packet responsible for showing the Toast to players
+     * Create the {@link AdvancementsPacket} responsible for showing the Toast to players
      *
      * @param notification the notification
      * @return the packet used to show the Toast

src/main/java/net/minestom/server/benchmark/BenchmarkManager.java

@@ -19,7 +19,13 @@ import java.util.concurrent.ConcurrentHashMap;
 
 import static net.minestom.server.MinecraftServer.*;
 
-public class BenchmarkManager {
+/**
+ * Small monitoring tools that can be used to check the current memory usage and Minestom threads CPU usage.
+ * <p>
+ * Needs to be enabled with {@link #enable(UpdateOption)}. Memory can then be accessed with {@link #getUsedMemory()}
+ * and the CPUs usage with {@link #getResultMap()} or {@link #getCpuMonitoringMessage()}.
+ */
+public final class BenchmarkManager {
 
     public static ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();
     private static List<String> threads = new ArrayList<>();
@@ -40,7 +46,7 @@ public class BenchmarkManager {
     private final Long2LongMap lastWaitedMap = new Long2LongOpenHashMap();
     private final Long2LongMap lastBlockedMap = new Long2LongOpenHashMap();
 
-    private Map<String, ThreadResult> resultMap = new ConcurrentHashMap<>();
+    private final Map<String, ThreadResult> resultMap = new ConcurrentHashMap<>();
 
     private boolean enabled = false;
     private volatile boolean stop = false;
@@ -115,7 +121,7 @@ public class BenchmarkManager {
     private void refreshData() {
         ThreadInfo[] threadInfo = threadMXBean.getThreadInfo(threadMXBean.getAllThreadIds());
         for (ThreadInfo threadInfo2 : threadInfo) {
-            String name = threadInfo2.getThreadName();
+            final String name = threadInfo2.getThreadName();
             boolean shouldBenchmark = false;
             for (String thread : threads) {
                 if (name.startsWith(thread)) {
@@ -126,32 +132,32 @@ public class BenchmarkManager {
             if (!shouldBenchmark)
                 continue;
 
-            long id = threadInfo2.getThreadId();
+            final long id = threadInfo2.getThreadId();
 
-            long lastCpuTime = lastCpuTimeMap.getOrDefault(id, 0L);
-            long lastUserTime = lastUserTimeMap.getOrDefault(id, 0L);
-            long lastWaitedTime = lastWaitedMap.getOrDefault(id, 0L);
-            long lastBlockedTime = lastBlockedMap.getOrDefault(id, 0L);
+            final long lastCpuTime = lastCpuTimeMap.getOrDefault(id, 0L);
+            final long lastUserTime = lastUserTimeMap.getOrDefault(id, 0L);
+            final long lastWaitedTime = lastWaitedMap.getOrDefault(id, 0L);
+            final long lastBlockedTime = lastBlockedMap.getOrDefault(id, 0L);
 
-            long blockedTime = threadInfo2.getBlockedTime();
-            long waitedTime = threadInfo2.getWaitedTime();
-            long cpuTime = threadMXBean.getThreadCpuTime(id);
-            long userTime = threadMXBean.getThreadUserTime(id);
+            final long blockedTime = threadInfo2.getBlockedTime();
+            final long waitedTime = threadInfo2.getWaitedTime();
+            final long cpuTime = threadMXBean.getThreadCpuTime(id);
+            final long userTime = threadMXBean.getThreadUserTime(id);
 
             lastCpuTimeMap.put(id, cpuTime);
             lastUserTimeMap.put(id, userTime);
             lastWaitedMap.put(id, waitedTime);
             lastBlockedMap.put(id, blockedTime);
 
-            double totalCpuTime = (double) (cpuTime - lastCpuTime) / 1000000D;
-            double totalUserTime = (double) (userTime - lastUserTime) / 1000000D;
-            long totalBlocked = blockedTime - lastBlockedTime;
-            long totalWaited = waitedTime - lastWaitedTime;
+            final double totalCpuTime = (double) (cpuTime - lastCpuTime) / 1000000D;
+            final double totalUserTime = (double) (userTime - lastUserTime) / 1000000D;
+            final long totalBlocked = blockedTime - lastBlockedTime;
+            final long totalWaited = waitedTime - lastWaitedTime;
 
-            double cpuPercentage = totalCpuTime / (double) time * 100L;
-            double userPercentage = totalUserTime / (double) time * 100L;
-            double waitedPercentage = totalWaited / (double) time * 100L;
-            double blockedPercentage = totalBlocked / (double) time * 100L;
+            final double cpuPercentage = totalCpuTime / (double) time * 100L;
+            final double userPercentage = totalUserTime / (double) time * 100L;
+            final double waitedPercentage = totalWaited / (double) time * 100L;
+            final double blockedPercentage = totalBlocked / (double) time * 100L;
 
             ThreadResult threadResult = new ThreadResult(cpuPercentage, userPercentage, waitedPercentage, blockedPercentage);
             resultMap.put(name, threadResult);

src/main/java/net/minestom/server/benchmark/ThreadResult.java

@@ -2,7 +2,7 @@ package net.minestom.server.benchmark;
 
 public class ThreadResult {
 
-    private double cpuPercentage, userPercentage, waitedPercentage, blockedPercentage;
+    private final double cpuPercentage, userPercentage, waitedPercentage, blockedPercentage;
 
     protected ThreadResult(double cpuPercentage, double userPercentage, double waitedPercentage, double blockedPercentage) {
         this.cpuPercentage = cpuPercentage;

src/main/java/net/minestom/server/map/Framebuffer.java

@@ -22,7 +22,7 @@ public interface Framebuffer {
             colors = toMapColors();
         } else {
             colors = new byte[width * height];
-            byte[] mapColors = toMapColors();
+            final byte[] mapColors = toMapColors();
             for (int y = minY; y < Math.min(HEIGHT, minY + height); y++) {
                 for (int x = minX; x < Math.min(WIDTH, minX + width); x++) {
                     byte color = mapColors[index(x, y, WIDTH)];

src/main/java/net/minestom/server/map/LargeFramebuffer.java

@@ -3,19 +3,22 @@ package net.minestom.server.map;
 import net.minestom.server.network.packet.server.play.MapDataPacket;
 
 /**
- * Framebuffer that is meant to be split in sub-framebuffers. Contrary to Framebuffer, LargeFramebuffer supports sizes over 128x128 pixels.
+ * Framebuffer that is meant to be split in sub-framebuffers.
+ * Contrary to {@link Framebuffer}, LargeFramebuffer supports sizes over 128x128 pixels.
  */
 public interface LargeFramebuffer {
 
     int width();
+
     int height();
 
     /**
-     * Returns a new Framebuffer that represent a 128x128 sub-view of this framebuffer.
+     * Returns a new {@link Framebuffer} that represent a 128x128 sub-view of this framebuffer.
      * Implementations are free (but not guaranteed) to throw exceptions if left & top produces out-of-bounds coordinates.
+     *
      * @param left
      * @param top
-     * @return
+     * @return the sub-view {@link Framebuffer}
      */
     Framebuffer createSubView(int left, int top);
 
@@ -23,17 +26,18 @@ public interface LargeFramebuffer {
 
     /**
      * Prepares the packet to render a 128x128 sub view of this framebuffer
-     * @param packet
+     *
+     * @param packet the {@link MapDataPacket} to prepare
      * @param left
      * @param top
      */
     default void preparePacket(MapDataPacket packet, int left, int top) {
         byte[] colors = new byte[Framebuffer.WIDTH * Framebuffer.WIDTH];
-        int width = Math.min(width(), left+Framebuffer.WIDTH) - left;
-        int height = Math.min(height(), top+Framebuffer.HEIGHT) - top;
+        final int width = Math.min(width(), left + Framebuffer.WIDTH) - left;
+        final int height = Math.min(height(), top + Framebuffer.HEIGHT) - top;
         for (int y = top; y < height; y++) {
             for (int x = left; x < width; x++) {
-                byte color = getMapColor(left, top);
+                final byte color = getMapColor(left, top);
                 colors[Framebuffer.index(x - left, y - top)] = color;
             }
         }

src/main/java/net/minestom/server/map/MapColors.java

@@ -65,8 +65,7 @@ public enum MapColors {
     WARPED_NYLIUM(22, 126, 134),
     WARPED_STEM(58, 142, 140),
     WARPED_HYPHAE(86, 44, 62),
-    WARPED_WART_BLOCK(20, 180, 133),
-    ;
+    WARPED_WART_BLOCK(20, 180, 133);
 
     private final int red;
     private final int green;
@@ -244,19 +243,19 @@ public enum MapColors {
             if (base == NONE)
                 continue;
             for (Multiplier m : Multiplier.values()) {
-                int rgbKey = PreciseMapColor.toRGB(base, m);
-                int redKey = (rgbKey >> 16) & 0xFF;
-                int greenKey = (rgbKey >> 8) & 0xFF;
-                int blueKey = rgbKey & 0xFF;
+                final int rgbKey = PreciseMapColor.toRGB(base, m);
+                final int redKey = (rgbKey >> 16) & 0xFF;
+                final int greenKey = (rgbKey >> 8) & 0xFF;
+                final int blueKey = rgbKey & 0xFF;
 
-                int red = (rgb >> 16) & 0xFF;
-                int green = (rgb >> 8) & 0xFF;
-                int blue = rgb & 0xFF;
+                final int red = (rgb >> 16) & 0xFF;
+                final int green = (rgb >> 8) & 0xFF;
+                final int blue = rgb & 0xFF;
 
-                int dr = redKey - red;
-                int dg = greenKey - green;
-                int db = blueKey - blue;
-                int dist = (dr * dr + dg * dg + db * db);
+                final int dr = redKey - red;
+                final int dg = greenKey - green;
+                final int db = blueKey - blue;
+                final int dist = (dr * dr + dg * dg + db * db);
                 if (dist < closestDistance) {
                     closest = new PreciseMapColor(base, m);
                     closestDistance = dist;
@@ -267,8 +266,8 @@ public enum MapColors {
     }
 
     public static class PreciseMapColor {
-        private MapColors baseColor;
-        private Multiplier multiplier;
+        private final MapColors baseColor;
+        private final Multiplier multiplier;
 
         PreciseMapColor(MapColors base, Multiplier multiplier) {
             this.baseColor = base;
@@ -300,9 +299,9 @@ public enum MapColors {
             g *= multiplier.multiplier();
             b *= multiplier.multiplier();
 
-            int red = (int) r;
-            int green = (int) g;
-            int blue = (int) b;
+            final int red = (int) r;
+            final int green = (int) g;
+            final int blue = (int) b;
             return (red << 16) | (green << 8) | blue;
         }
     }
@@ -311,8 +310,7 @@ public enum MapColors {
         x1_00(MapColors::baseColor, 1.00),
         x0_53(MapColors::multiply53, 0.53),
         x0_71(MapColors::multiply71, 0.71),
-        x0_86(MapColors::multiply86, 0.86),
-        ;
+        x0_86(MapColors::multiply86, 0.86);
 
         private final Function<MapColors, Byte> indexGetter;
         private final double multiplier;

src/main/java/net/minestom/server/map/MapHandle.java

@@ -1,14 +0,0 @@
-package net.minestom.server.map;
-
-public class MapHandle {
-
-    private int mapId;
-
-    protected MapHandle(int mapId) {
-        this.mapId = mapId;
-    }
-
-    public int getMapId() {
-        return mapId;
-    }
-}

src/main/java/net/minestom/server/map/MapManager.java

@@ -1,14 +0,0 @@
-package net.minestom.server.map;
-
-import it.unimi.dsi.fastutil.ints.Int2ObjectMap;
-import it.unimi.dsi.fastutil.ints.Int2ObjectOpenHashMap;
-
-public class MapManager {
-
-    private Int2ObjectMap<MapHandle> objectMap = new Int2ObjectOpenHashMap<>();
-
-    public MapHandle getMap(int mapId) {
-        return objectMap.computeIfAbsent(mapId, id -> new MapHandle(id));
-    }
-
-}

src/main/java/net/minestom/server/map/framebuffers/DirectFramebuffer.java

@@ -3,7 +3,7 @@ package net.minestom.server.map.framebuffers;
 import net.minestom.server.map.Framebuffer;
 
 /**
- * Framebuffer with direct access to the colors array
+ * {@link Framebuffer} with direct access to the colors array
  */
 public class DirectFramebuffer implements Framebuffer {
 
@@ -11,6 +11,7 @@ public class DirectFramebuffer implements Framebuffer {
 
     /**
      * Mutable colors array
+     *
      * @return
      */
     public byte[] getColors() {

src/main/java/net/minestom/server/map/framebuffers/Graphics2DFramebuffer.java

@@ -1,7 +1,6 @@
 package net.minestom.server.map.framebuffers;
 
 import net.minestom.server.map.Framebuffer;
-import net.minestom.server.map.LargeFramebuffer;
 import net.minestom.server.map.MapColors;
 
 import java.awt.*;
@@ -9,7 +8,7 @@ import java.awt.image.BufferedImage;
 import java.awt.image.DataBufferInt;
 
 /**
- * Framebuffer that embeds a BufferedImage, allowing for rendering directly via Graphics2D or its pixel array
+ * {@link Framebuffer} that embeds a BufferedImage, allowing for rendering directly via Graphics2D or its pixel array.
  */
 public class Graphics2DFramebuffer implements Framebuffer {
 

src/main/java/net/minestom/server/map/framebuffers/LargeDirectFramebuffer.java

@@ -5,8 +5,8 @@ import net.minestom.server.map.LargeFramebuffer;
 import net.minestom.server.map.MapColors;
 
 /**
- * Large framebuffer with direct access to the colors array.
- *
+ * {@link LargeFramebuffer} with direct access to the colors array.
+ * <p>
  * This implementation does not throw errors when accessing out-of-bounds coordinates through sub-views, and will instead
  * use {@link MapColors#NONE}. This is only the case for sub-views, access through {@link #setMapColor(int, int, byte)}
  * and {@link #getMapColor(int, int)} will throw an exception if out-of-bounds coordinates are inputted.
@@ -19,6 +19,7 @@ public class LargeDirectFramebuffer implements LargeFramebuffer {
 
     /**
      * Creates a new {@link LargeDirectFramebuffer} with the desired size
+     *
      * @param width
      * @param height
      */

src/main/java/net/minestom/server/map/framebuffers/LargeGraphics2DFramebuffer.java

@@ -9,11 +9,11 @@ import java.awt.image.BufferedImage;
 import java.awt.image.DataBufferInt;
 
 /**
- * LargeFramebuffer that embeds a BufferedImage, allowing for rendering directly via Graphics2D or its pixel array
+ * {@link LargeFramebuffer} that embeds a {@link BufferedImage},
+ * allowing for rendering directly via {@link Graphics2D} or its pixel array.
  */
 public class LargeGraphics2DFramebuffer implements LargeFramebuffer {
 
-    private final byte[] colors;
     private final BufferedImage backingImage;
     private final Graphics2D renderer;
     private final int[] pixels;
@@ -23,7 +23,6 @@ public class LargeGraphics2DFramebuffer implements LargeFramebuffer {
     public LargeGraphics2DFramebuffer(int width, int height) {
         this.width = width;
         this.height = height;
-        colors = new byte[width*height];
         backingImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB);
         renderer = backingImage.createGraphics();
         pixels = ((DataBufferInt) backingImage.getRaster().getDataBuffer()).getData();

src/main/java/net/minestom/server/utils/advancement/AdvancementUtils.java

@@ -9,7 +9,7 @@ public final class AdvancementUtils {
     }
 
     /**
-     * Get an {@link AdvancementsPacket} which remove the specified identifiers
+     * Get an {@link AdvancementsPacket} which remove the specified identifiers.
      *
      * @param identifiers the identifiers to remove
      * @return the packet to remove all the identifiers