From aaec5eda8bafaeb5b3684532e27aaccb06f77a88 Mon Sep 17 00:00:00 2001 From: Aurora Lahtela <24460436+AuroraLS3@users.noreply.github.com> Date: Wed, 31 Aug 2022 10:08:37 +0300 Subject: [PATCH] Add since tags and remove some internal deprecated code --- .../java/com/djrapitops/plan/PlanSystem.java | 5 +- .../java/com/djrapitops/plan/api/PlanAPI.java | 2 +- .../plan/api/data/PlayerContainer.java | 2 +- .../plan/data/element/AnalysisContainer.java | 2 +- .../plan/data/element/InspectContainer.java | 2 +- .../plan/data/element/TableContainer.java | 2 +- .../djrapitops/plan/data/plugin/BanData.java | 2 +- .../plan/data/plugin/PluginData.java | 2 +- .../store/containers/AnalysisContainer.java | 2 +- .../plan/delivery/domain/WebUser.java | 4 +- .../plan/delivery/domain/auth/User.java | 10 +++- .../delivery/domain/keys/AnalysisKeys.java | 2 +- .../delivery/rendering/html/icon/Family.java | 2 +- .../html/structure/DynamicHtmlTable.java | 5 +- .../rendering/html/structure/HtmlTable.java | 5 +- .../structure/HtmlTableWithColoredHeader.java | 5 +- .../plan/gathering/domain/PlayerKill.java | 56 ------------------- .../plan/gathering/domain/UserInfo.java | 2 +- .../plan/settings/theme/ThemeVal.java | 7 +-- .../database/sql/tables/UserInfoTable.java | 2 +- .../plan/storage/file/PlanFiles.java | 5 -- .../plan/utilities/html/icon/Color.java | 2 +- .../plan/utilities/html/icon/Family.java | 2 +- .../plan/utilities/html/icon/Icon.java | 2 +- .../database/DatabaseTestPreparer.java | 3 + .../utilities/mocks/PlanVelocityMocker.java | 5 -- 26 files changed, 45 insertions(+), 95 deletions(-) diff --git a/Plan/common/src/main/java/com/djrapitops/plan/PlanSystem.java b/Plan/common/src/main/java/com/djrapitops/plan/PlanSystem.java index 94a181684..8cef35336 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/PlanSystem.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/PlanSystem.java @@ -145,7 +145,10 @@ public class PlanSystem implements SubSystem { logger.info("ยง2"); } - @Deprecated + /** + * @deprecated Use {@link com.djrapitops.plan.delivery.webserver.Addresses} instead. + */ + @Deprecated(since = "Addresses.java") public String getMainAddress() { return webServerSystem.getAddresses().getMainAddress().orElse(webServerSystem.getAddresses().getFallbackLocalhostAddress()); } diff --git a/Plan/common/src/main/java/com/djrapitops/plan/api/PlanAPI.java b/Plan/common/src/main/java/com/djrapitops/plan/api/PlanAPI.java index 8e1724a6a..2f5fa51d8 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/api/PlanAPI.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/api/PlanAPI.java @@ -37,7 +37,7 @@ import java.util.UUID; * @author AuroraLS3 * @deprecated Plan API v4 has been deprecated, use the APIv5 instead (https://github.com/plan-player-analytics/Plan/wiki/APIv5). */ -@Deprecated +@Deprecated(since = "5.0") public interface PlanAPI { static PlanAPI getInstance() { diff --git a/Plan/common/src/main/java/com/djrapitops/plan/api/data/PlayerContainer.java b/Plan/common/src/main/java/com/djrapitops/plan/api/data/PlayerContainer.java index edfa87da3..c308dcd13 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/api/data/PlayerContainer.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/api/data/PlayerContainer.java @@ -31,7 +31,7 @@ import java.util.Optional; * @author AuroraLS3 * @deprecated Plan API v4 has been deprecated, use the APIv5 instead (https://github.com/plan-player-analytics/Plan/wiki/APIv5). */ -@Deprecated +@Deprecated(since = "5.0") public class PlayerContainer { private final com.djrapitops.plan.delivery.domain.container.PlayerContainer container; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/data/element/AnalysisContainer.java b/Plan/common/src/main/java/com/djrapitops/plan/data/element/AnalysisContainer.java index 5d3b4bfca..618f566f0 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/data/element/AnalysisContainer.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/data/element/AnalysisContainer.java @@ -29,7 +29,7 @@ import java.util.UUID; * @see InspectContainer * @deprecated PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API. */ -@Deprecated +@Deprecated(since = "5.0") public final class AnalysisContainer extends InspectContainer { private final Map> playerTableValues; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/data/element/InspectContainer.java b/Plan/common/src/main/java/com/djrapitops/plan/data/element/InspectContainer.java index 541fd690b..964ca0462 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/data/element/InspectContainer.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/data/element/InspectContainer.java @@ -29,7 +29,7 @@ import java.util.TreeMap; * @see TableContainer * @deprecated PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API. */ -@Deprecated +@Deprecated(since = "5.0") public class InspectContainer { protected final List values; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/data/element/TableContainer.java b/Plan/common/src/main/java/com/djrapitops/plan/data/element/TableContainer.java index 1dc3eff33..e265e21f5 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/data/element/TableContainer.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/data/element/TableContainer.java @@ -28,7 +28,7 @@ import java.util.List; * @author AuroraLS3 * @deprecated PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API. */ -@Deprecated +@Deprecated(since = "5.0") public class TableContainer { protected final String[] header; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/BanData.java b/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/BanData.java index d5aff5533..ea2e31153 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/BanData.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/BanData.java @@ -25,7 +25,7 @@ import java.util.UUID; * @author AuroraLS3 * @deprecated PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API. */ -@Deprecated +@Deprecated(since = "5.0") public interface BanData { boolean isBanned(UUID uuid); diff --git a/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/PluginData.java b/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/PluginData.java index d420092b6..96f849a09 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/PluginData.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/data/plugin/PluginData.java @@ -35,7 +35,7 @@ import java.util.UUID; * @author AuroraLS3 * @deprecated PluginData API has been deprecated - see https://github.com/plan-player-analytics/Plan/wiki/APIv5---DataExtension-API for new API. */ -@Deprecated +@Deprecated(since = "5.0") public abstract class PluginData { private final ContainerSize size; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/data/store/containers/AnalysisContainer.java b/Plan/common/src/main/java/com/djrapitops/plan/data/store/containers/AnalysisContainer.java index 2c6b37cec..377bfb139 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/data/store/containers/AnalysisContainer.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/data/store/containers/AnalysisContainer.java @@ -24,6 +24,6 @@ import com.djrapitops.plan.delivery.domain.container.DynamicDataContainer; * @author AuroraLS3 * @deprecated AnalysisContainer is no longer used. */ -@Deprecated +@Deprecated(since = "5.0") public class AnalysisContainer extends DynamicDataContainer { } \ No newline at end of file diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/WebUser.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/WebUser.java index ff5a149e0..f41ab67ac 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/WebUser.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/WebUser.java @@ -24,10 +24,10 @@ import java.util.Objects; * Object containing webserver security user information. * * @author AuroraLS3 - *

+ * @deprecated Use {@link com.djrapitops.plan.delivery.domain.auth.User} instead * TODO Rewrite Authentication stuff */ -@Deprecated +@Deprecated(since = "2022-02-12, User.java") public class WebUser { private final String username; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/User.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/User.java index a41decee2..e89dff5dc 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/User.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/auth/User.java @@ -70,12 +70,18 @@ public class User implements Comparable { return passwordHash; } - @Deprecated + /** + * @deprecated Permission list should be used instead. + */ + @Deprecated(since = "2022-05-04", forRemoval = true) public int getPermissionLevel() { return permissionLevel; } - @Deprecated + /** + * @deprecated Permission list should be used instead. + */ + @Deprecated(since = "2022-05-04", forRemoval = true) public void setPermissionLevel(int permissionLevel) { this.permissionLevel = permissionLevel; } diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/keys/AnalysisKeys.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/keys/AnalysisKeys.java index b14d06828..b3ea4cbd4 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/keys/AnalysisKeys.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/domain/keys/AnalysisKeys.java @@ -25,7 +25,7 @@ package com.djrapitops.plan.delivery.domain.keys; * @see com.djrapitops.plan.data.store.containers.AnalysisContainer for Suppliers for each Key. * @deprecated AnalysisContainer can no longer be obtained, so this is deprecated. */ -@Deprecated +@Deprecated(since = "5.0") public class AnalysisKeys { public static final PlaceholderKey TIME_ZONE = CommonPlaceholderKeys.TIME_ZONE; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/icon/Family.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/icon/Family.java index a860ae70f..b53a96ad2 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/icon/Family.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/icon/Family.java @@ -22,7 +22,7 @@ public enum Family { SOLID("fa"), REGULAR("far"), BRAND("fab"), - @Deprecated + @Deprecated(since = "5.0") LINE(" material-icons"); private final String familyClass; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/DynamicHtmlTable.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/DynamicHtmlTable.java index b8074ef00..d96f8351d 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/DynamicHtmlTable.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/DynamicHtmlTable.java @@ -23,7 +23,10 @@ import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.List; -@Deprecated +/** + * @deprecated Table html generation is to be done in frontend in the future. + */ +@Deprecated(since = "5.5") public class DynamicHtmlTable implements HtmlTable { private final Header[] headers; private final List rows; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTable.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTable.java index 3ae9b80b7..f66f2e401 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTable.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTable.java @@ -29,7 +29,10 @@ import java.util.List; import java.util.Objects; import java.util.stream.Collectors; -@Deprecated +/** + * @deprecated Table html generation is to be done in frontend in the future. + */ +@Deprecated(since = "5.5") public interface HtmlTable { static HtmlTable fromExtensionTable(Table table, com.djrapitops.plan.extension.icon.Color tableColor) { diff --git a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTableWithColoredHeader.java b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTableWithColoredHeader.java index ff3a1fb99..a812d942b 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTableWithColoredHeader.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/structure/HtmlTableWithColoredHeader.java @@ -22,7 +22,10 @@ import com.djrapitops.plan.extension.table.Table; import java.util.List; -@Deprecated +/** + * @deprecated Table html generation is to be done in frontend in the future. + */ +@Deprecated(since = "5.5") public class HtmlTableWithColoredHeader implements HtmlTable { private final Header[] headers; private final Color headerColor; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/PlayerKill.java b/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/PlayerKill.java index 895395307..2c2777402 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/PlayerKill.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/PlayerKill.java @@ -21,7 +21,6 @@ import com.djrapitops.plan.delivery.domain.PlayerIdentifier; import com.djrapitops.plan.delivery.domain.ServerIdentifier; import java.util.Objects; -import java.util.Optional; import java.util.UUID; /** @@ -37,41 +36,6 @@ public class PlayerKill implements DateHolder { private final long date; private final ServerIdentifier server; - /** - * Creates a PlayerKill object with given parameters. - * - * @param killer UUID of the killer. - * @param victim UUID of the victim. - * @param weapon Weapon used. - * @param date Epoch millisecond at which the kill occurred. - */ - @Deprecated - public PlayerKill(UUID killer, UUID victim, String weapon, long date) { - this.killer = new Killer(killer, null); - this.victim = new Victim(victim, null); - this.weapon = weapon; - this.date = date; - this.server = new ServerIdentifier(null, ""); - } - - @Deprecated - public PlayerKill(UUID killer, UUID victim, String weapon, long date, String victimName) { - this.killer = new Killer(killer, null); - this.victim = new Victim(victim, victimName); - this.weapon = weapon; - this.date = date; - this.server = new ServerIdentifier(null, ""); - } - - @Deprecated - public PlayerKill(UUID killer, UUID victim, String weapon, long date, String victimName, String killerName) { - this.killer = new Killer(killer, killerName); - this.victim = new Victim(victim, victimName); - this.weapon = weapon; - this.date = date; - this.server = new ServerIdentifier(null, ""); - } - public PlayerKill(Killer killer, Victim victim, ServerIdentifier server, String weapon, long date) { this.killer = killer; this.victim = victim; @@ -80,26 +44,6 @@ public class PlayerKill implements DateHolder { this.server = server; } - @Deprecated - public UUID getKillerUUID() { - return killer.getUuid(); - } - - @Deprecated - public UUID getVictimUUID() { - return victim.getUuid(); - } - - @Deprecated - public Optional getVictimName() { - return Optional.ofNullable(victim.getName()); - } - - @Deprecated - public Optional getKillerName() { - return Optional.ofNullable(killer.getName()); - } - public Killer getKiller() { return killer; } diff --git a/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/UserInfo.java b/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/UserInfo.java index 862999d19..5d6791a8a 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/UserInfo.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/gathering/domain/UserInfo.java @@ -58,7 +58,7 @@ public class UserInfo { /** * @deprecated Join address is now stored in {@link FinishedSession#getExtraData()}, this method may become unreliable in the future. */ - @Deprecated + @Deprecated(since = "5.4 build 1722") public String getJoinAddress() { return joinAddress; } diff --git a/Plan/common/src/main/java/com/djrapitops/plan/settings/theme/ThemeVal.java b/Plan/common/src/main/java/com/djrapitops/plan/settings/theme/ThemeVal.java index 84ab42597..f5e7706bf 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/settings/theme/ThemeVal.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/settings/theme/ThemeVal.java @@ -67,12 +67,7 @@ public enum ThemeVal { GRAPH_MAX_PING("GraphColors.Ping.Max", "#ffa000"), GRAPH_MIN_PING("GraphColors.Ping.Min", "#ffd54f"), WORLD_MAP_HIGH("GraphColors.WorldMap_High", "#267f00"), - WORLD_MAP_LOW("GraphColors.WorldMap_Low", "#EEFFEE"), - - @Deprecated - PARSED_SESSION_ACCORDION("ParsedElements.SessionAccordion", "teal"), - @Deprecated - PARSED_SERVER_ACCORDION("ParsedElements.ServerAccordion", "light-green"); + WORLD_MAP_LOW("GraphColors.WorldMap_Low", "#EEFFEE"); private final String themePath; private final String defaultValue; diff --git a/Plan/common/src/main/java/com/djrapitops/plan/storage/database/sql/tables/UserInfoTable.java b/Plan/common/src/main/java/com/djrapitops/plan/storage/database/sql/tables/UserInfoTable.java index 61650d586..259192d64 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/storage/database/sql/tables/UserInfoTable.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/storage/database/sql/tables/UserInfoTable.java @@ -45,7 +45,7 @@ public class UserInfoTable { /** * @deprecated Join address is now stored in {@link JoinAddressTable}, this column may become unreliable in the future. */ - @Deprecated + @Deprecated(since = "5.4 build 1722") public static final String JOIN_ADDRESS = "join_address"; public static final String INSERT_STATEMENT = "INSERT INTO " + TABLE_NAME + " (" + diff --git a/Plan/common/src/main/java/com/djrapitops/plan/storage/file/PlanFiles.java b/Plan/common/src/main/java/com/djrapitops/plan/storage/file/PlanFiles.java index b4fef6c15..4a8c57410 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/storage/file/PlanFiles.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/storage/file/PlanFiles.java @@ -67,11 +67,6 @@ public class PlanFiles implements SubSystem { return dataFolder.toPath(); } - @Deprecated - public Path getCustomizationDirectory() { - return config.get().getResourceSettings().getCustomizationDirectory(); - } - public File getLogsFolder() { try { File folder = getFileFromPluginFolder("logs"); diff --git a/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Color.java b/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Color.java index 46e70c69e..e6be812da 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Color.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Color.java @@ -21,7 +21,7 @@ import java.util.Optional; /** * @deprecated This Class exists to keep plugins that used PluginData from breaking. */ -@Deprecated +@Deprecated(since = "5.0") public enum Color { RED("col-red"), PINK("col-pink"), diff --git a/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Family.java b/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Family.java index e13b676a7..db5007368 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Family.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Family.java @@ -21,7 +21,7 @@ import java.util.Optional; /** * @deprecated This Class exists to keep plugins that used PluginData from breaking. */ -@Deprecated +@Deprecated(since = "5.0") public enum Family { SOLID(" fa fa-", "\">"), REGULAR(" far fa-", "\">"), diff --git a/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Icon.java b/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Icon.java index 44da91f3b..3fbcaaedc 100644 --- a/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Icon.java +++ b/Plan/common/src/main/java/com/djrapitops/plan/utilities/html/icon/Icon.java @@ -19,7 +19,7 @@ package com.djrapitops.plan.utilities.html.icon; /** * @deprecated This Class exists to keep plugins that used PluginData from breaking. */ -@Deprecated +@Deprecated(since = "5.0") public class Icon { private Family type; diff --git a/Plan/common/src/test/java/com/djrapitops/plan/storage/database/DatabaseTestPreparer.java b/Plan/common/src/test/java/com/djrapitops/plan/storage/database/DatabaseTestPreparer.java index 55c53a8f2..851790f2e 100644 --- a/Plan/common/src/test/java/com/djrapitops/plan/storage/database/DatabaseTestPreparer.java +++ b/Plan/common/src/test/java/com/djrapitops/plan/storage/database/DatabaseTestPreparer.java @@ -41,6 +41,9 @@ public interface DatabaseTestPreparer { ServerUUID serverUUID(); + /** + * @deprecated Dependencies may not include the full system in the future. + */ @Deprecated PlanSystem system(); diff --git a/Plan/velocity/src/test/java/utilities/mocks/PlanVelocityMocker.java b/Plan/velocity/src/test/java/utilities/mocks/PlanVelocityMocker.java index c5374884f..4739596c0 100644 --- a/Plan/velocity/src/test/java/utilities/mocks/PlanVelocityMocker.java +++ b/Plan/velocity/src/test/java/utilities/mocks/PlanVelocityMocker.java @@ -55,11 +55,6 @@ public class PlanVelocityMocker { return this; } - @Deprecated - public PlanVelocityMocker withLogging() { - return this; - } - public PlanVelocityMocker withProxy() { ProxyServer server = Mockito.mock(ProxyServer.class);