More API v2 changes :)

Author: TBlueF

build.gradle.kts

@@ -21,7 +21,8 @@ repositories {
 
 dependencies {
     api ("com.flowpowered:flow-math:1.0.3")
-    implementation ("com.google.code.gson:gson:2.8.0")
+    api ("com.google.code.gson:gson:2.8.0")
+
     compileOnly ("org.jetbrains:annotations:23.0.0")
 }
 

src/main/java/de/bluecolored/bluemap/api/BlueMapAPI.java

@@ -24,6 +24,8 @@
  */
 package de.bluecolored.bluemap.api;
 
+import de.bluecolored.bluemap.api.debug.DebugDump;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URL;
@@ -72,24 +74,28 @@ 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 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();
 
     /**
@@ -122,12 +128,14 @@ 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;
     }

src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java

@@ -27,6 +27,7 @@
 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.marker.MarkerSet;
 
 import java.util.Map;
@@ -42,38 +43,44 @@ 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();
 
     /**
      * 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();
 
     /**

src/main/java/de/bluecolored/bluemap/api/BlueMapWorld.java

@@ -24,6 +24,8 @@
  */
 package de.bluecolored.bluemap.api;
 
+import de.bluecolored.bluemap.api.debug.DebugDump;
+
 import java.nio.file.Path;
 import java.util.Collection;
 
@@ -36,18 +38,21 @@ public interface BlueMapWorld {
      * Getter for the id of this world.
      * @return the id of this world
      */
+    @DebugDump
     String getId();
 
     /**
      * Getter for the {@link Path} of this world's save-files (folder). This matches the folder configured in bluemap's config for this map ( <code>world:</code> ).
      * @return the save-folder of this world.
      */
+    @DebugDump
     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();
 
 }

src/main/java/de/bluecolored/bluemap/api/RenderManager.java

@@ -25,6 +25,7 @@
 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;
@@ -74,18 +75,21 @@ 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();
 
     /**

src/main/java/de/bluecolored/bluemap/api/WebApp.java

@@ -1,5 +1,30 @@
+/*
+ * This file is part of BlueMap, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) Blue (Lukas Rieger) <https://bluecolored.de>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
 package de.bluecolored.bluemap.api;
 
+import de.bluecolored.bluemap.api.debug.DebugDump;
 import de.bluecolored.bluemap.api.marker.Marker;
 import de.bluecolored.bluemap.api.marker.POIMarker;
 import com.flowpowered.math.vector.Vector2i;
@@ -16,6 +41,7 @@ public interface WebApp {
      * Getter for the configured web-root folder
      * @return The {@link Path} of the web-root folder
      */
+    @DebugDump
     Path getWebRoot();
 
     /**
@@ -50,6 +76,7 @@ public interface WebApp {
      * </ul>
      * @throws IOException If an {@link IOException} is thrown while reading the images
      */
+    @DebugDump
     Map<String, String> availableImages() throws IOException;
 
 }

src/main/java/de/bluecolored/bluemap/api/debug/DebugDump.java

@@ -0,0 +1,46 @@
+/*
+ * This file is part of BlueMap, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) Blue (Lukas Rieger) <https://bluecolored.de>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package de.bluecolored.bluemap.api.debug;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+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>
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({
+        ElementType.METHOD,
+        ElementType.FIELD,
+        ElementType.TYPE
+})
+public @interface DebugDump {
+
+    String value() default "";
+
+}

src/main/java/de/bluecolored/bluemap/api/marker/DistanceRangedMarker.java

@@ -25,7 +25,9 @@
 package de.bluecolored.bluemap.api.marker;
 
 import com.flowpowered.math.vector.Vector3d;
+import de.bluecolored.bluemap.api.debug.DebugDump;
 
+@DebugDump
 public abstract class DistanceRangedMarker extends Marker {
 
     private double minDistance, maxDistance;

src/main/java/de/bluecolored/bluemap/api/marker/ExtrudeMarker.java

@@ -26,11 +26,15 @@
 
 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;
 
 import java.util.Objects;
 
+@DebugDump
 public class ExtrudeMarker extends ObjectMarker {
+    private static final Shape DEFAULT_SHAPE = Shape.createRect(0, 0, 1, 1);
 
     private Shape shape;
     private float shapeMinY, shapeMaxY;
@@ -39,6 +43,14 @@ public class ExtrudeMarker extends ObjectMarker {
     private Color lineColor = new Color(255, 0, 0, 1f);
     private Color fillColor = new Color(200, 0, 0, 0.3f);
 
+    /**
+     * Empty constructor for deserialization.
+     */
+    @SuppressWarnings("unused")
+    private ExtrudeMarker() {
+        this("", DEFAULT_SHAPE, 0, 0);
+    }
+
     /**
      * Creates a new {@link ExtrudeMarker}.
      * <p><i>(The position of the marker will be the center of the shape (it's bounding box))</i></p>

src/main/java/de/bluecolored/bluemap/api/marker/HtmlMarker.java

@@ -27,17 +27,27 @@
 
 import com.flowpowered.math.vector.Vector2i;
 import com.flowpowered.math.vector.Vector3d;
+import de.bluecolored.bluemap.api.debug.DebugDump;
 
 import java.util.Objects;
 
 /**
  * A marker that is a html-element placed somewhere on the map.
  */
+@DebugDump
 public class HtmlMarker extends DistanceRangedMarker {
 
     private Vector2i anchor;
     private String html;
 
+    /**
+     * Empty constructor for deserialization.
+     */
+    @SuppressWarnings("unused")
+    private HtmlMarker() {
+        this("", Vector3d.ZERO, "");
+    }
+
     /**
      * Creates a new {@link HtmlMarker}.
      *