From 51f61f61af08c3e539cf5a32cab97fcf1bd0e649 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 21 Jul 2020 01:06:37 +0200 Subject: [PATCH 1/2] Add missing deprecation notices. --- src/main/java/me/clip/placeholderapi/PlaceholderAPI.java | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java index caf76ab..7082cb3 100644 --- a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java +++ b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java @@ -240,7 +240,8 @@ public final class PlaceholderAPI * identifier from the params * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return The text containing the parsed placeholders - * @deprecated this will do absolutely nothing different + * + * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @NotNull @Deprecated @@ -620,4 +621,4 @@ public final class PlaceholderAPI return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); } -} \ No newline at end of file +} From 75004f08d0740d5bb3d98b87d4931c04b432e99d Mon Sep 17 00:00:00 2001 From: Andre601 <11576465+Andre601@users.noreply.github.com> Date: Tue, 21 Jul 2020 01:20:26 +0200 Subject: [PATCH 2/2] Add deprecation notice to all methods Was it so hard to do a Ctrl+C, Ctrl+V? --- .../clip/placeholderapi/PlaceholderAPI.java | 71 +++++++++++++++---- 1 file changed, 57 insertions(+), 14 deletions(-) diff --git a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java index 7082cb3..19f66d2 100644 --- a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java +++ b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java @@ -228,7 +228,7 @@ public final class PlaceholderAPI } - // === Deprecated API === (please don't use this, thank you - Sxtanna :P) + // === Deprecated API === /** * Translates all placeholders into their corresponding values. @@ -240,8 +240,7 @@ public final class PlaceholderAPI * identifier from the params * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return The text containing the parsed placeholders - * - * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, String)} instead. + * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, String)} instead */ @NotNull @Deprecated @@ -260,6 +259,7 @@ public final class PlaceholderAPI * identifier from the params * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return String containing all translated placeholders + * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, List)} instead */ @NotNull @Deprecated @@ -283,6 +283,7 @@ public final class PlaceholderAPI * * @param text String to check * @return true if String contains any registered placeholder identifiers, false otherwise + * @deprecated Will be removed in a future release. */ @Deprecated public static boolean containsPlaceholders(String text) @@ -295,6 +296,7 @@ public final class PlaceholderAPI * * @param text String to check * @return true if String contains any registered placeholder identifiers, false otherwise + * @deprecated Will be removed in a future release. */ @Deprecated public static boolean containsBracketPlaceholders(String text) @@ -309,6 +311,7 @@ public final class PlaceholderAPI * @param player Player to parse the placeholders against * @param text List of Strings to set the placeholder values in * @return String containing all translated placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. */ @Deprecated public static List setBracketPlaceholders(OfflinePlayer player, List text) @@ -324,6 +327,7 @@ public final class PlaceholderAPI * @param text List of Strings to set the placeholder values in * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return String containing all translated placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. */ @Deprecated public static List setBracketPlaceholders(OfflinePlayer player, List text, boolean colorize) @@ -339,6 +343,7 @@ public final class PlaceholderAPI * @param text List of Strings to set the placeholder values in * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return String containing all translated placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. */ @Deprecated public static List setPlaceholders(OfflinePlayer player, List text, boolean colorize) @@ -355,6 +360,7 @@ public final class PlaceholderAPI * @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the * identifier from the params * @return String containing all translated placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. */ @Deprecated public static List setPlaceholders(OfflinePlayer player, List text, Pattern pattern) @@ -369,6 +375,7 @@ public final class PlaceholderAPI * @param player Player to parse the placeholders against * @param text Text to set the placeholder values in * @return String containing all translated placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @Deprecated public static String setBracketPlaceholders(OfflinePlayer player, String text) @@ -384,6 +391,7 @@ public final class PlaceholderAPI * @param text Text to set the placeholder values in * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return String containing all translated placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @Deprecated public static String setBracketPlaceholders(OfflinePlayer player, String text, boolean colorize) @@ -399,6 +407,7 @@ public final class PlaceholderAPI * @param text Text to parse the placeholders in * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return The text containing the parsed placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @Deprecated public static String setPlaceholders(OfflinePlayer player, String text, boolean colorize) @@ -415,6 +424,7 @@ public final class PlaceholderAPI * @param pattern The pattern to match placeholders to. Capture group 1 must contain an underscore separating the * identifier from the params * @return The text containing the parsed placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @Deprecated public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern) @@ -430,6 +440,7 @@ public final class PlaceholderAPI * @param two Player to compare * @param text text to parse the placeholder values to * @return The text containing the parsed relational placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. */ @Deprecated public static List setRelationalPlaceholders(Player one, Player two, List text) @@ -446,6 +457,7 @@ public final class PlaceholderAPI * @param text Text to parse the placeholders in * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return The text containing the parsed relational placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. */ @Deprecated public static List setRelationalPlaceholders(Player one, Player two, List text, boolean colorize) @@ -468,6 +480,7 @@ public final class PlaceholderAPI * @param two Second player to compare * @param text Text to parse the placeholders in * @return The text containing the parsed relational placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @Deprecated public static String setRelationalPlaceholders(Player one, Player two, String text) @@ -484,6 +497,7 @@ public final class PlaceholderAPI * @param text Text to parse the placeholders in * @param colorize If color codes (&[0-1a-fk-o]) should be translated * @return The text containing the parsed relational placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. */ @Deprecated @SuppressWarnings("DuplicatedCode") @@ -536,6 +550,7 @@ public final class PlaceholderAPI * Gets the placeholder pattern for the default placeholders. * * @return The pattern for {@literal %_%} + * @deprecated Will be removed in a future release. */ @Deprecated public static Pattern getPlaceholderPattern() @@ -547,6 +562,7 @@ public final class PlaceholderAPI * Gets the placeholder pattern for the bracket placeholders. * * @return The pattern for {@literal {_}} + * @deprecated Will be removed in a future release. */ @Deprecated public static Pattern getBracketPlaceholderPattern() @@ -558,63 +574,90 @@ public final class PlaceholderAPI * Gets the placeholder pattern for the relational placeholders. * * @return The pattern for {@literal %rel__%} + * @deprecated Will be removed in a future release. */ @Deprecated public static Pattern getRelationalPlaceholderPattern() { return RELATIONAL_PLACEHOLDER_PATTERN; } - - + + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static Set getRegisteredPlaceholderPlugins() { return getRegisteredIdentifiers(); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static Set getExternalPlaceholderPlugins() { return null; } - - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static String setPlaceholders(Player player, String text, boolean colorize) { return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static List setPlaceholders(Player player, List text) { return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static List setPlaceholders(Player player, List text, boolean colorize) { return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static String setBracketPlaceholders(Player player, String text) { return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static String setBracketPlaceholders(Player player, String text, boolean colorize) { return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static List setBracketPlaceholders(Player player, List text) { return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true); } - + + /** + * @deprecated Will be removed in a future release. + */ @Deprecated public static List setBracketPlaceholders(Player player, List text, boolean colorize) {