Deprecate/remove DebugDump annotation

BlueMap-Minecraft · May 15, 2024 · 8b179fb · 8b179fb
1 parent 6c84500
commit 8b179fb
Show file tree

Hide file tree

Showing 19 changed files with 2 additions and 60 deletions.
diff --git a/src/main/java/de/bluecolored/bluemap/api/BlueMapAPI.java b/src/main/java/de/bluecolored/bluemap/api/BlueMapAPI.java
@@ -27,7 +27,6 @@
 import com.google.gson.Gson;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import de.bluecolored.bluemap.api.plugin.Plugin;
 
 import java.io.InputStream;
@@ -78,35 +77,30 @@ public abstract class BlueMapAPI {
      * Getter for the {@link RenderManager}.
      * @return the {@link RenderManager}
      */
-    @DebugDump
     public abstract RenderManager getRenderManager();
 
     /**
      * Getter for the {@link WebApp}.
      * @return the {@link WebApp}
      */
-    @DebugDump
     public abstract WebApp getWebApp();
 
     /**
      * Getter for the {@link Plugin}
      * @return the {@link Plugin}
      */
-    @DebugDump
     public abstract Plugin getPlugin();
 
     /**
      * Getter for all {@link BlueMapMap}s loaded by BlueMap.
      * @return an unmodifiable collection of all loaded {@link BlueMapMap}s
      */
-    @DebugDump
     public abstract Collection<BlueMapMap> getMaps();
 
     /**
      * Getter for all {@link BlueMapWorld}s loaded by BlueMap.
      * @return an unmodifiable collection of all loaded {@link BlueMapWorld}s
      */
-    @DebugDump
     public abstract Collection<BlueMapWorld> getWorlds();
 
     /**
@@ -137,14 +131,12 @@ public abstract class BlueMapAPI {
      * Getter for the installed BlueMap version
      * @return the version-string
      */
-    @DebugDump
     public abstract String getBlueMapVersion();
 
     /**
      * Getter for the installed BlueMapAPI version
      * @return the version-string
      */
-    @DebugDump
     public String getAPIVersion() {
         return VERSION;
     }

diff --git a/src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java b/src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java
@@ -27,7 +27,6 @@
 import com.flowpowered.math.vector.Vector2i;
 import com.flowpowered.math.vector.Vector3d;
 import com.flowpowered.math.vector.Vector3i;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import de.bluecolored.bluemap.api.markers.MarkerSet;
 
 import java.util.Map;
@@ -43,21 +42,18 @@ public interface BlueMapMap {
      * Returns this maps id, this is equal to the id configured in bluemap's config for this map.
      * @return the id of this map
      */
-    @DebugDump
     String getId();
 
     /**
      * Returns this maps display-name, this is equal to the name configured in bluemap's config for this map.
      * @return the name of this map
      */
-    @DebugDump
     String getName();
 
     /**
      * Getter for the {@link BlueMapWorld} of this map.
      * @return the {@link BlueMapWorld} of this map
      */
-    @DebugDump
     BlueMapWorld getWorld();
 
     /**
@@ -66,30 +62,26 @@ public interface BlueMapMap {
      * is displaying this map. E.g. these assets are also available in server-networks.
      * @return the {@link AssetStorage} of this map
      */
-    @DebugDump
     AssetStorage getAssetStorage();
 
     /**
      * Getter for a (modifiable) {@link Map} of {@link MarkerSet}s with the key being the {@link MarkerSet}'s id.
      * Changing this map will change the {@link MarkerSet}s and markers displayed on the web-app for this map.
      * @return a {@link Map} of {@link MarkerSet}s.
      */
-    @DebugDump
     Map<String, MarkerSet> getMarkerSets();
 
     /**
      * Getter for the size of all tiles on this map in blocks.
      * @return the tile-size in blocks
      */
-    @DebugDump
     Vector2i getTileSize();
 
     /**
      * Getter for the offset of the tile-grid on this map.<br>
      * E.g. an offset of (2|-1) would mean that the tile (0|0) has block (2|0|-1) at it's min-corner.
      * @return the tile-offset in blocks
      */
-    @DebugDump
     Vector2i getTileOffset();
 
     /**

diff --git a/src/main/java/de/bluecolored/bluemap/api/BlueMapWorld.java b/src/main/java/de/bluecolored/bluemap/api/BlueMapWorld.java
@@ -24,8 +24,6 @@
  */
 package de.bluecolored.bluemap.api;
 
-import de.bluecolored.bluemap.api.debug.DebugDump;
-
 import java.nio.file.Path;
 import java.util.Collection;
 
@@ -38,7 +36,6 @@ public interface BlueMapWorld {
      * Getter for the id of this world.
      * @return the id of this world
      */
-    @DebugDump
     String getId();
 
     /**
@@ -47,15 +44,13 @@ public interface BlueMapWorld {
      * @return the save-folder of this world.
      * @deprecated Getting the save-folder of a world is no longer supported. As it is not guaranteed that every world has a save-folder.
      */
-    @DebugDump
     @Deprecated
     Path getSaveFolder();
 
     /**
      * Getter for all {@link BlueMapMap}s for this world
      * @return an unmodifiable {@link Collection} of all {@link BlueMapMap}s for this world
      */
-    @DebugDump
     Collection<BlueMapMap> getMaps();
 
 }
diff --git a/src/main/java/de/bluecolored/bluemap/api/RenderManager.java b/src/main/java/de/bluecolored/bluemap/api/RenderManager.java
@@ -25,7 +25,6 @@
 package de.bluecolored.bluemap.api;
 
 import com.flowpowered.math.vector.Vector2i;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 
 import java.io.IOException;
 import java.util.Collection;
@@ -75,21 +74,18 @@ default boolean scheduleMapUpdateTask(BlueMapMap map) {
      * Getter for the current size of the render-queue.
      * @return the current size of the render-queue
      */
-    @DebugDump
     int renderQueueSize();
 
     /**
      * Getter for the current count of render threads.
      * @return the count of render threads
      */
-    @DebugDump
     int renderThreadCount();
 
     /**
      * Whether this {@link RenderManager} is currently running or stopped.
      * @return <code>true</code> if this renderer is running
      */
-    @DebugDump
     boolean isRunning();
 
     /**

diff --git a/src/main/java/de/bluecolored/bluemap/api/WebApp.java b/src/main/java/de/bluecolored/bluemap/api/WebApp.java
@@ -24,8 +24,6 @@
  */
 package de.bluecolored.bluemap.api;
 
-import de.bluecolored.bluemap.api.debug.DebugDump;
-
 import java.awt.image.BufferedImage;
 import java.io.IOException;
 import java.nio.file.Path;
@@ -39,7 +37,6 @@ public interface WebApp {
      * Getter for the configured web-root folder
      * @return The {@link Path} of the web-root folder
      */
-    @DebugDump
     Path getWebRoot();
 
     /**

diff --git a/src/main/java/de/bluecolored/bluemap/api/debug/DebugDump.java b/src/main/java/de/bluecolored/bluemap/api/debug/DebugDump.java
@@ -30,15 +30,15 @@
 import java.lang.annotation.Target;
 
 /**
- * Marks a class, field or method to be included in detail in a possible state-dump.
- * E.g. triggered by <code>/bluemap debug dump</code>
+ * @deprecated not implemented, unused
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({
         ElementType.METHOD,
         ElementType.FIELD,
         ElementType.TYPE
 })
+@Deprecated(forRemoval = true)
 public @interface DebugDump {
 
     String value() default "";

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/DistanceRangedMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/DistanceRangedMarker.java
@@ -25,7 +25,6 @@
 package de.bluecolored.bluemap.api.markers;
 
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 
 /**
  * @see HtmlMarker
@@ -34,7 +33,6 @@
  * @see ExtrudeMarker
  * @see LineMarker
  */
-@DebugDump
 public abstract class DistanceRangedMarker extends Marker {
 
     private double minDistance, maxDistance;

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/ExtrudeMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/ExtrudeMarker.java
@@ -26,7 +26,6 @@
 
 import com.flowpowered.math.vector.Vector2d;
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import de.bluecolored.bluemap.api.math.Color;
 import de.bluecolored.bluemap.api.math.Shape;
 
@@ -36,7 +35,6 @@
 import java.util.Objects;
 
 @SuppressWarnings("FieldMayBeFinal")
-@DebugDump
 public class ExtrudeMarker extends ObjectMarker {
     private static final Shape DEFAULT_SHAPE = Shape.createRect(0, 0, 1, 1);
 

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/HtmlMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/HtmlMarker.java
@@ -27,15 +27,13 @@
 
 import com.flowpowered.math.vector.Vector2i;
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 
 import java.util.*;
 
 /**
  * A marker that is a html-element placed somewhere on the map.
  */
 @SuppressWarnings("FieldMayBeFinal")
-@DebugDump
 public class HtmlMarker extends DistanceRangedMarker implements ElementMarker {
 
     private Set<String> classes = new HashSet<>();

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/LineMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/LineMarker.java
@@ -25,13 +25,11 @@
 package de.bluecolored.bluemap.api.markers;
 
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import de.bluecolored.bluemap.api.math.Color;
 import de.bluecolored.bluemap.api.math.Line;
 
 import java.util.Objects;
 
-@DebugDump
 public class LineMarker extends ObjectMarker {
     private static final Line DEFAULT_LINE = new Line(Vector3d.ZERO, Vector3d.ONE);
 

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/Marker.java b/src/main/java/de/bluecolored/bluemap/api/markers/Marker.java
@@ -25,7 +25,6 @@
 package de.bluecolored.bluemap.api.markers;
 
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 
 import java.util.Objects;
 
@@ -38,7 +37,6 @@
  * @see ExtrudeMarker
  * @see LineMarker
  */
-@DebugDump
 public abstract class Marker {
 
     private final String type;

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/MarkerSet.java b/src/main/java/de/bluecolored/bluemap/api/markers/MarkerSet.java
@@ -24,16 +24,13 @@
  */
 package de.bluecolored.bluemap.api.markers;
 
-import de.bluecolored.bluemap.api.debug.DebugDump;
-
 import java.util.Map;
 import java.util.Objects;
 import java.util.concurrent.ConcurrentHashMap;
 
 /**
  * A set of {@link Marker}s that are displayed on the maps in the web-app.
  */
-@DebugDump
 public class MarkerSet {
 
     private String label;

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/ObjectMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/ObjectMarker.java
@@ -25,7 +25,6 @@
 package de.bluecolored.bluemap.api.markers;
 
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Objects;
@@ -36,7 +35,6 @@
  * @see ExtrudeMarker
  * @see LineMarker
  */
-@DebugDump
 public abstract class ObjectMarker extends DistanceRangedMarker implements DetailMarker {
 
     private String detail;

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/POIMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/POIMarker.java
@@ -27,12 +27,10 @@
 import com.flowpowered.math.vector.Vector2i;
 import com.flowpowered.math.vector.Vector3d;
 import de.bluecolored.bluemap.api.BlueMapMap;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 
 import java.util.*;
 
 @SuppressWarnings("FieldMayBeFinal")
-@DebugDump
 public class POIMarker extends DistanceRangedMarker implements DetailMarker, ElementMarker {
 
     private Set<String> classes = new HashSet<>();

diff --git a/src/main/java/de/bluecolored/bluemap/api/markers/ShapeMarker.java b/src/main/java/de/bluecolored/bluemap/api/markers/ShapeMarker.java
@@ -27,7 +27,6 @@
 
 import com.flowpowered.math.vector.Vector2d;
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import de.bluecolored.bluemap.api.math.Color;
 import de.bluecolored.bluemap.api.math.Shape;
 
@@ -37,7 +36,6 @@
 import java.util.Objects;
 
 @SuppressWarnings("FieldMayBeFinal")
-@DebugDump
 public class ShapeMarker extends ObjectMarker {
     private static final Shape DEFAULT_SHAPE = Shape.createRect(0, 0, 1, 1);
 

diff --git a/src/main/java/de/bluecolored/bluemap/api/math/Color.java b/src/main/java/de/bluecolored/bluemap/api/math/Color.java
@@ -24,11 +24,8 @@
  */
 package de.bluecolored.bluemap.api.math;
 
-import de.bluecolored.bluemap.api.debug.DebugDump;
-
 import java.util.Objects;
 
-@DebugDump
 public class Color {
 
     private final int r, g, b;

diff --git a/src/main/java/de/bluecolored/bluemap/api/math/Line.java b/src/main/java/de/bluecolored/bluemap/api/math/Line.java
@@ -25,7 +25,6 @@
 package de.bluecolored.bluemap.api.math;
 
 import com.flowpowered.math.vector.Vector3d;
-import de.bluecolored.bluemap.api.debug.DebugDump;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
@@ -36,7 +35,6 @@
 /**
  * A line consisting of 2 or more {@link Vector3d}-points.
  */
-@DebugDump
 public class Line {
 
     private final Vector3d[] points;