From 4210a3a555e89214133c4ce8b8a291da955470f0 Mon Sep 17 00:00:00 2001 From: Alexander Brandes Date: Mon, 6 Mar 2023 10:13:03 +0100 Subject: [PATCH] Deprecate unused methods for removal (#3977) --- .../core/configuration/Config.java | 6 ++ .../core/generator/HybridUtils.java | 4 + .../plotsquared/core/plot/PlotSettings.java | 4 + .../com/plotsquared/core/util/BlockUtil.java | 4 + .../com/plotsquared/core/util/ChunkUtil.java | 2 + .../com/plotsquared/core/util/MathMan.java | 86 +++++++++++++++++++ .../com/plotsquared/core/util/RegionUtil.java | 4 + .../com/plotsquared/core/util/StringMan.java | 56 ++++++++++++ .../com/plotsquared/core/util/WEManager.java | 16 ++++ 9 files changed, 182 insertions(+) diff --git a/Core/src/main/java/com/plotsquared/core/configuration/Config.java b/Core/src/main/java/com/plotsquared/core/configuration/Config.java index e154d493e..8e6b065eb 100644 --- a/Core/src/main/java/com/plotsquared/core/configuration/Config.java +++ b/Core/src/main/java/com/plotsquared/core/configuration/Config.java @@ -50,7 +50,9 @@ public class Config { * @param root configuration class * @param value type * @return value + * @deprecated Unused internally. Scheduled for removal in next major release. */ + @Deprecated(forRemoval = true, since = "TODO") @SuppressWarnings("unchecked") public static T get(String key, Class root) { String[] split = key.split("\\."); @@ -445,6 +447,10 @@ public class Config { return INSTANCES.values(); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public Collection getSections() { return INSTANCES.keySet(); } diff --git a/Core/src/main/java/com/plotsquared/core/generator/HybridUtils.java b/Core/src/main/java/com/plotsquared/core/generator/HybridUtils.java index 0def7d9cb..06a35dbab 100644 --- a/Core/src/main/java/com/plotsquared/core/generator/HybridUtils.java +++ b/Core/src/main/java/com/plotsquared/core/generator/HybridUtils.java @@ -380,6 +380,10 @@ public class HybridUtils { run.run(); } + /** + * @deprecated Unused internally and poor implementation. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public int checkModified(QueueCoordinator queue, int x1, int x2, int y1, int y2, int z1, int z2, BlockState[] blocks) { int count = 0; for (int y = y1; y <= y2; y++) { diff --git a/Core/src/main/java/com/plotsquared/core/plot/PlotSettings.java b/Core/src/main/java/com/plotsquared/core/plot/PlotSettings.java index 6e727a095..b56fe200a 100644 --- a/Core/src/main/java/com/plotsquared/core/plot/PlotSettings.java +++ b/Core/src/main/java/com/plotsquared/core/plot/PlotSettings.java @@ -79,6 +79,10 @@ public class PlotSettings { this.ratings = ratings; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. Use {@link PlotSettings#setMerged(Direction, boolean)} + */ + @Deprecated(forRemoval = true, since = "TODO") public boolean setMerged(int direction, boolean merged) { if (this.merged[direction] != merged) { this.merged[direction] = merged; diff --git a/Core/src/main/java/com/plotsquared/core/util/BlockUtil.java b/Core/src/main/java/com/plotsquared/core/util/BlockUtil.java index b590c4731..c55f20dae 100644 --- a/Core/src/main/java/com/plotsquared/core/util/BlockUtil.java +++ b/Core/src/main/java/com/plotsquared/core/util/BlockUtil.java @@ -114,7 +114,9 @@ public final class BlockUtil { * * @param commaDelimited List of block states * @return Parsed block states + * @deprecated Unused internally. Scheduled for removal in next major release. */ + @Deprecated(forRemoval = true, since = "TODO") public static @NonNull BlockState[] parse(final @NonNull String commaDelimited) { final String[] split = commaDelimited.split(",(?![^\\(\\[]*[\\]\\)])"); final BlockState[] result = new BlockState[split.length]; @@ -130,7 +132,9 @@ public final class BlockUtil { * @param map Serialized block state * @return Deserialized block state, or {@code null} if the map is * not a properly serialized block state + * @deprecated Unused internally. Scheduled for removal in next major release. */ + @Deprecated(forRemoval = true, since = "TODO") public static @Nullable BlockState deserialize(final @NonNull Map map) { if (map.containsKey("material")) { final Object object = map.get("material"); diff --git a/Core/src/main/java/com/plotsquared/core/util/ChunkUtil.java b/Core/src/main/java/com/plotsquared/core/util/ChunkUtil.java index 3667b1aa1..9fee0e046 100644 --- a/Core/src/main/java/com/plotsquared/core/util/ChunkUtil.java +++ b/Core/src/main/java/com/plotsquared/core/util/ChunkUtil.java @@ -114,7 +114,9 @@ public class ChunkUtil { * @param pos2 Region maximum point * @param chunk BlockVector2 of chunk coordinates * @return {@code true} if the region pos1-pos2 contains the chunk + * @deprecated Unused internally. Scheduled for removal in next major release. */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isWholeChunk(@NonNull Location pos1, @NonNull Location pos2, @NonNull BlockVector2 chunk) { int x1 = pos1.getX(); int z1 = pos1.getZ(); diff --git a/Core/src/main/java/com/plotsquared/core/util/MathMan.java b/Core/src/main/java/com/plotsquared/core/util/MathMan.java index f7ec56008..08cfaf090 100644 --- a/Core/src/main/java/com/plotsquared/core/util/MathMan.java +++ b/Core/src/main/java/com/plotsquared/core/util/MathMan.java @@ -70,35 +70,67 @@ public class MathMan { return result; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static long pairInt(int x, int y) { return (((long) x) << 32) | (y & 0xffffffffL); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static int unpairIntX(long pair) { return (int) (pair >> 32); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static int unpairIntY(long pair) { return (int) pair; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static byte pair16(byte x, byte y) { return (byte) (x + (y << 4)); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static byte unpair16x(byte value) { return (byte) (value & 0xF); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static byte unpair16y(byte value) { return (byte) ((value >> 4) & 0xF); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static long inverseRound(double val) { long round = Math.round(val); return (long) (round + Math.signum(val - round)); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static int sqrt(int x) { int xn; @@ -175,6 +207,10 @@ public class MathMan { return count / array.length; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static double getMean(double[] array) { double count = 0; for (double i : array) { @@ -191,10 +227,19 @@ public class MathMan { return (a & b) + (a ^ b) / 2; } + + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static short unpairX(int hash) { return (short) (hash >> 16); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static short unpairY(int hash) { return (short) (hash & 0xFFFF); } @@ -205,13 +250,19 @@ public class MathMan { * @param yaw yaw * @param pitch pitch * @return x, y, z unit vector + * @deprecated Unused internally. Scheduled for removal in next major release. */ + @Deprecated(forRemoval = true, since = "TODO") public static float[] getDirection(float yaw, float pitch) { double pitch_sin = Math.sin(pitch); return new float[]{(float) (pitch_sin * Math.cos(yaw)), (float) (pitch_sin * Math.sin(yaw)), (float) Math.cos(pitch)}; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static int floorMod(int x, int y) { int i = x % y; if (i < 0) { @@ -231,12 +282,18 @@ public class MathMan { * @param y y * @param z z * @return pitch and yaw of x,y,z from 0,0,0 + * @deprecated Unused internally. Scheduled for removal in next major release. */ + @Deprecated(forRemoval = true, since = "TODO") public static float[] getPitchAndYaw(float x, float y, float z) { float distance = sqrtApprox((z * z) + (x * x)); return new float[]{atan2(y, distance), atan2(x, z)}; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static final float atan2(float y, float x) { float add; float mul; @@ -272,15 +329,28 @@ public class MathMan { return (atan2[(yi * ATAN2_DIM) + xi] + add) * mul; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static float sqrtApprox(float f) { return f * Float.intBitsToFloat(0x5f375a86 - (Float.floatToIntBits(f) >> 1)); } + + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static double sqrtApprox(double d) { return Double .longBitsToDouble(((Double.doubleToLongBits(d) - (1L << 52)) >> 1) + (1L << 61)); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static float invSqrt(float x) { float xhalf = 0.5f * x; int i = Float.floatToIntBits(x); @@ -321,6 +391,10 @@ public class MathMan { return true; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static double getSD(double[] array, double av) { double sd = 0; for (double element : array) { @@ -337,6 +411,10 @@ public class MathMan { return Math.sqrt(sd / array.length); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static int mod(int x, int y) { if (isPowerOfTwo(y)) { return x & (y - 1); @@ -344,6 +422,10 @@ public class MathMan { return x % y; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static int unsignedmod(int x, int y) { if (isPowerOfTwo(y)) { return x & (y - 1); @@ -351,6 +433,10 @@ public class MathMan { return x % y; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isPowerOfTwo(int number) { return (number & (number - 1)) == 0; } diff --git a/Core/src/main/java/com/plotsquared/core/util/RegionUtil.java b/Core/src/main/java/com/plotsquared/core/util/RegionUtil.java index 4ee917b84..d53008052 100644 --- a/Core/src/main/java/com/plotsquared/core/util/RegionUtil.java +++ b/Core/src/main/java/com/plotsquared/core/util/RegionUtil.java @@ -95,6 +95,10 @@ public class RegionUtil { .getY() && y <= max.getY(); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static @NonNull Rectangle2D toRectangle(final @NonNull CuboidRegion region) { final BlockVector2 min = region.getMinimumPoint().toBlockVector2(); final BlockVector2 max = region.getMaximumPoint().toBlockVector2(); diff --git a/Core/src/main/java/com/plotsquared/core/util/StringMan.java b/Core/src/main/java/com/plotsquared/core/util/StringMan.java index 32a594ea2..ba73edaa3 100644 --- a/Core/src/main/java/com/plotsquared/core/util/StringMan.java +++ b/Core/src/main/java/com/plotsquared/core/util/StringMan.java @@ -39,6 +39,10 @@ public class StringMan { // Stolen from https://stackoverflow.com/a/366532/12620913 | Debug: https://regex101.com/r/DudJLb/1 private static final Pattern STRING_SPLIT_PATTERN = Pattern.compile("[^\\s\"]+|\"([^\"]*)\""); + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static String replaceFromMap(String string, Map replacements) { StringBuilder sb = new StringBuilder(string); int size = string.length(); @@ -70,6 +74,10 @@ public class StringMan { return count; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static String getString(Object obj) { if (obj == null) { return "null"; @@ -102,6 +110,10 @@ public class StringMan { } } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static String replaceFirst(char c, String s) { if (s == null) { return ""; @@ -128,6 +140,10 @@ public class StringMan { return s; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static String replaceAll(String string, Object... pairs) { StringBuilder sb = new StringBuilder(string); for (int i = 0; i < pairs.length; i += 2) { @@ -144,6 +160,10 @@ public class StringMan { return sb.toString(); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isAlphanumeric(String str) { for (int i = 0; i < str.length(); i++) { char c = str.charAt(i); @@ -165,6 +185,10 @@ public class StringMan { return true; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isAlpha(String str) { for (int i = 0; i < str.length(); i++) { char c = str.charAt(i); @@ -185,14 +209,26 @@ public class StringMan { return join(array, delimiter); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static String join(Collection collection, char delimiter) { return join(collection.toArray(), delimiter + ""); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isAsciiPrintable(char c) { return (c >= ' ') && (c < ''); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isAsciiPrintable(String s) { for (char c : s.toCharArray()) { if (!isAsciiPrintable(c)) { @@ -249,6 +285,10 @@ public class StringMan { return result.toString(); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static String join(int[] array, String delimiter) { Integer[] wrapped = new Integer[array.length]; for (int i = 0; i < array.length; i++) { @@ -257,6 +297,10 @@ public class StringMan { return join(wrapped, delimiter); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isEqualToAny(String a, String... args) { for (String arg : args) { if (StringMan.isEqual(a, arg)) { @@ -284,6 +328,10 @@ public class StringMan { return a.equals(b); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean isEqualIgnoreCase(String a, String b) { return a.equals(b) || ((a != null) && (b != null) && (a.length() == b.length()) && a .equalsIgnoreCase(b)); @@ -295,6 +343,10 @@ public class StringMan { return sb.toString(); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean contains(String name, char c) { for (char current : name.toCharArray()) { if (c == current) { @@ -304,6 +356,10 @@ public class StringMan { return false; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public Collection match(Collection col, String startsWith) { if (col == null) { return null; diff --git a/Core/src/main/java/com/plotsquared/core/util/WEManager.java b/Core/src/main/java/com/plotsquared/core/util/WEManager.java index 377160114..0275113d1 100644 --- a/Core/src/main/java/com/plotsquared/core/util/WEManager.java +++ b/Core/src/main/java/com/plotsquared/core/util/WEManager.java @@ -58,6 +58,10 @@ public class WEManager { return false; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean maskContains(Set mask, double dx, double dy, double dz) { int x = Math.toIntExact(Math.round(dx >= 0 ? dx - 0.5 : dx + 0.5)); int y = Math.toIntExact(Math.round(dy - 0.5)); @@ -70,6 +74,10 @@ public class WEManager { return false; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean maskContains(Set mask, double dx, double dz) { int x = Math.toIntExact(Math.round(dx >= 0 ? dx - 0.5 : dx + 0.5)); int z = Math.toIntExact(Math.round(dz >= 0 ? dz - 0.5 : dz + 0.5)); @@ -116,10 +124,18 @@ public class WEManager { return regions; } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean intersects(CuboidRegion region1, CuboidRegion region2) { return RegionUtil.intersects(region1, region2); } + /** + * @deprecated Unused internally. Scheduled for removal in next major release. + */ + @Deprecated(forRemoval = true, since = "TODO") public static boolean regionContains(CuboidRegion selection, HashSet mask) { for (CuboidRegion region : mask) { if (intersects(region, selection)) {