Upstream
/
BlueMapAPI
mirror of https://github.com/BlueMap-Minecraft/BlueMapAPI.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Deprecate/remove DebugDump annotation

This commit is contained in:
Lukas Rieger (Blue) 2024-05-15 23:46:25 +02:00
parent 6c84500dfc
commit 8b179fb5e0
No known key found for this signature in database
GPG Key ID: AA33883B1BBA03E6
19 changed files with 2 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/main/java/de/bluecolored/bluemap/api/BlueMapAPI.java
View File

@ -27,7 +27,6 @@ package de.bluecolored.bluemap.api;
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;
}

8
src/main/java/de/bluecolored/bluemap/api/BlueMapMap.java
View File

@ -27,7 +27,6 @@ package de.bluecolored.bluemap.api;
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,7 +62,6 @@ 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();
/**
@ -74,14 +69,12 @@ public interface BlueMapMap {
* 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();
/**
@ -89,7 +82,6 @@ public interface BlueMapMap {
* 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();
/**

5
src/main/java/de/bluecolored/bluemap/api/BlueMapWorld.java
View File

@ -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,7 +44,6 @@ 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();
@ -55,7 +51,6 @@ public interface BlueMapWorld {
* 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();
}

4
src/main/java/de/bluecolored/bluemap/api/RenderManager.java
View File

@ -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 @@ public interface RenderManager {
* 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();
/**

3
src/main/java/de/bluecolored/bluemap/api/WebApp.java
View File

@ -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();
/**

4
src/main/java/de/bluecolored/bluemap/api/debug/DebugDump.java
View File

@ -30,8 +30,7 @@ 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>
* @deprecated not implemented, unused
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({
@ -39,6 +38,7 @@ import java.lang.annotation.Target;
ElementType.FIELD,
ElementType.TYPE
})
@Deprecated(forRemoval = true)
public @interface DebugDump {
String value() default "";

2
src/main/java/de/bluecolored/bluemap/api/markers/DistanceRangedMarker.java
View File

@ -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 @@ import de.bluecolored.bluemap.api.debug.DebugDump;
* @see ExtrudeMarker
* @see LineMarker
*/
@DebugDump
public abstract class DistanceRangedMarker extends Marker {
private double minDistance, maxDistance;

2
src/main/java/de/bluecolored/bluemap/api/markers/ExtrudeMarker.java
View File

@ -26,7 +26,6 @@ package de.bluecolored.bluemap.api.markers;
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.Collection;
import java.util.Objects;
@SuppressWarnings("FieldMayBeFinal")
@DebugDump
public class ExtrudeMarker extends ObjectMarker {
private static final Shape DEFAULT_SHAPE = Shape.createRect(0, 0, 1, 1);

2
src/main/java/de/bluecolored/bluemap/api/markers/HtmlMarker.java
View File

@ -27,7 +27,6 @@ package de.bluecolored.bluemap.api.markers;
import com.flowpowered.math.vector.Vector2i;
import com.flowpowered.math.vector.Vector3d;
import de.bluecolored.bluemap.api.debug.DebugDump;
import java.util.*;
@ -35,7 +34,6 @@ 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<>();

2
src/main/java/de/bluecolored/bluemap/api/markers/LineMarker.java
View File

@ -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);

2
src/main/java/de/bluecolored/bluemap/api/markers/Marker.java
View File

@ -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 @@ import java.util.Objects;
* @see ExtrudeMarker
* @see LineMarker
*/
@DebugDump
public abstract class Marker {
private final String type;

3
src/main/java/de/bluecolored/bluemap/api/markers/MarkerSet.java
View File

@ -24,8 +24,6 @@
*/
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;
@ -33,7 +31,6 @@ 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;

2
src/main/java/de/bluecolored/bluemap/api/markers/ObjectMarker.java
View File

@ -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 @@ import java.util.Optional;
* @see ExtrudeMarker
* @see LineMarker
*/
@DebugDump
public abstract class ObjectMarker extends DistanceRangedMarker implements DetailMarker {
private String detail;

2
src/main/java/de/bluecolored/bluemap/api/markers/POIMarker.java
View File

@ -27,12 +27,10 @@ package de.bluecolored.bluemap.api.markers;
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<>();

2
src/main/java/de/bluecolored/bluemap/api/markers/ShapeMarker.java
View File

@ -27,7 +27,6 @@ package de.bluecolored.bluemap.api.markers;
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.Collection;
import java.util.Objects;
@SuppressWarnings("FieldMayBeFinal")
@DebugDump
public class ShapeMarker extends ObjectMarker {
private static final Shape DEFAULT_SHAPE = Shape.createRect(0, 0, 1, 1);

3
src/main/java/de/bluecolored/bluemap/api/math/Color.java
View File

@ -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;

2
src/main/java/de/bluecolored/bluemap/api/math/Line.java
View File

@ -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 @@ import java.util.List;
/**
* A line consisting of 2 or more {@link Vector3d}-points.
*/
@DebugDump
public class Line {
private final Vector3d[] points;

2
src/main/java/de/bluecolored/bluemap/api/math/Shape.java
View File

@ -25,7 +25,6 @@
package de.bluecolored.bluemap.api.math;
import com.flowpowered.math.vector.Vector2d;
import de.bluecolored.bluemap.api.debug.DebugDump;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
@ -36,7 +35,6 @@ import java.util.List;
/**
* A shape consisting of 3 or more {@link Vector2d}-points on a plane.
*/
@DebugDump
public class Shape {
private final Vector2d[] points;

4
src/main/java/de/bluecolored/bluemap/api/plugin/Plugin.java
View File

@ -24,15 +24,12 @@
*/
package de.bluecolored.bluemap.api.plugin;
import de.bluecolored.bluemap.api.debug.DebugDump;
public interface Plugin {
/**
* Get the {@link SkinProvider} that bluemap is using to fetch player-skins
* @return the {@link SkinProvider} instance bluemap is using
*/
@DebugDump
SkinProvider getSkinProvider();
/**
@ -46,7 +43,6 @@ public interface Plugin {
* for the Player-Markers
* @return The {@link PlayerIconFactory} bluemap uses to convert skins into player-marker icons
*/
@DebugDump
PlayerIconFactory getPlayerMarkerIconFactory();
/**