From 87a6d5f709885017f50fcea26a737d57511d22cc Mon Sep 17 00:00:00 2001 From: Noah van der Aa Date: Tue, 21 Sep 2021 19:51:24 +0200 Subject: [PATCH 1/3] api: Add inVersion to all @ApiStatus.ScheduledForRemoval annotations (#450) --- .../net/kyori/adventure/bossbar/BossBar.java | 10 +++++----- .../java/net/kyori/adventure/text/Component.java | 16 ++++++++-------- .../net/kyori/adventure/text/TextComponent.java | 2 +- .../text/serializer/ComponentSerializer.java | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/api/src/main/java/net/kyori/adventure/bossbar/BossBar.java b/api/src/main/java/net/kyori/adventure/bossbar/BossBar.java index 3629137d3..0d207ab99 100644 --- a/api/src/main/java/net/kyori/adventure/bossbar/BossBar.java +++ b/api/src/main/java/net/kyori/adventure/bossbar/BossBar.java @@ -71,7 +71,7 @@ public interface BossBar extends Examinable { * @deprecated for removal since 4.2.0, use {@link #MIN_PROGRESS} * @since 4.0.0 */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated float MIN_PERCENT = MIN_PROGRESS; /** @@ -80,7 +80,7 @@ public interface BossBar extends Examinable { * @deprecated for removal since 4.2.0, use {@link #MAX_PROGRESS} * @since 4.0.0 */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated float MAX_PERCENT = MAX_PROGRESS; @@ -212,7 +212,7 @@ public interface BossBar extends Examinable { * @deprecated for removal since 4.2.0, use {@link #progress()} * @since 4.0.0 */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated default float percent() { return this.progress(); @@ -229,7 +229,7 @@ default float percent() { * @deprecated for removal since 4.2.0, use {@link #progress(float)} * @since 4.0.0 */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract("_ -> this") @Deprecated default @NotNull BossBar percent(final float progress) { @@ -418,7 +418,7 @@ default void bossBarProgressChanged(final @NotNull BossBar bar, final float oldP * @deprecated for removal since 4.2.0, use {@link #bossBarProgressChanged(BossBar, float, float)} * @since 4.0.0 */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated @SuppressWarnings("DeprecatedIsStillUsed") default void bossBarPercentChanged(final @NotNull BossBar bar, final float oldProgress, final float newProgress) { diff --git a/api/src/main/java/net/kyori/adventure/text/Component.java b/api/src/main/java/net/kyori/adventure/text/Component.java index 06d015f3d..0f4f7d06b 100644 --- a/api/src/main/java/net/kyori/adventure/text/Component.java +++ b/api/src/main/java/net/kyori/adventure/text/Component.java @@ -2112,7 +2112,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceText(final @NotNull String search, final @Nullable ComponentLike replacement) { @@ -2128,7 +2128,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceText(final @NotNull Pattern pattern, final @NotNull Function replacement) { @@ -2144,7 +2144,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceFirstText(final @NotNull String search, final @Nullable ComponentLike replacement) { @@ -2160,7 +2160,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceFirstText(final @NotNull Pattern pattern, final @NotNull Function replacement) { @@ -2177,7 +2177,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceText(final @NotNull String search, final @Nullable ComponentLike replacement, final int numberOfReplacements) { @@ -2194,7 +2194,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceText(final @NotNull Pattern pattern, final @NotNull Function replacement, final int numberOfReplacements) { @@ -2213,7 +2213,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceText(final @NotNull String search, final @Nullable ComponentLike replacement, final @NotNull IntFunction2 fn) { @@ -2232,7 +2232,7 @@ default boolean hasStyling() { * @since 4.0.0 * @deprecated for removal since 4.2.0, use {@link #replaceText(Consumer)} or {@link #replaceText(TextReplacementConfig)} instead. */ - @ApiStatus.ScheduledForRemoval + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Contract(pure = true) @Deprecated default @NotNull Component replaceText(final @NotNull Pattern pattern, final @NotNull Function replacement, final @NotNull IntFunction2 fn) { diff --git a/api/src/main/java/net/kyori/adventure/text/TextComponent.java b/api/src/main/java/net/kyori/adventure/text/TextComponent.java index 33fdf1118..c1e1e1745 100644 --- a/api/src/main/java/net/kyori/adventure/text/TextComponent.java +++ b/api/src/main/java/net/kyori/adventure/text/TextComponent.java @@ -47,7 +47,7 @@ public interface TextComponent extends BuildableComponent Date: Wed, 22 Sep 2021 21:47:00 +0200 Subject: [PATCH 2/3] api: Add ScheduleForRemoval to everything marked as deprecated for removal in javadoc --- .../main/java/net/kyori/adventure/text/Component.java | 3 +++ .../main/java/net/kyori/adventure/util/ShadyPines.java | 3 +++ .../text/serializer/plain/PlainComponentSerializer.java | 9 +++++++++ 3 files changed, 15 insertions(+) diff --git a/api/src/main/java/net/kyori/adventure/text/Component.java b/api/src/main/java/net/kyori/adventure/text/Component.java index 0f4f7d06b..86027a09b 100644 --- a/api/src/main/java/net/kyori/adventure/text/Component.java +++ b/api/src/main/java/net/kyori/adventure/text/Component.java @@ -152,6 +152,7 @@ public interface Component extends ComponentBuilderApplicable, ComponentLike, Ex * @since 4.0.0 * @deprecated for removal since 4.9.0, use {@link #join(JoinConfiguration, ComponentLike...)} with {@link JoinConfiguration#separator(ComponentLike)} instead. */ + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated @Contract(value = "_, _ -> new", pure = true) static @NotNull TextComponent join(final @NotNull ComponentLike separator, final @NotNull ComponentLike@NotNull... components) { @@ -167,6 +168,7 @@ public interface Component extends ComponentBuilderApplicable, ComponentLike, Ex * @since 4.0.0 * @deprecated for removal since 4.9.0, use {@link #join(JoinConfiguration, Iterable)} with {@link JoinConfiguration#separator(ComponentLike)} instead. */ + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated @Contract(value = "_, _ -> new", pure = true) static @NotNull TextComponent join(final @NotNull ComponentLike separator, final Iterable components) { @@ -1657,6 +1659,7 @@ default boolean contains(final @NotNull Component that, final @NotNull BiPredica * @deprecated for removal since 4.7.0, with no replacement - this method is not necessary due to the fact {@code Component}s are immutable * @since 4.0.0 */ + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated default void detectCycle(final @NotNull Component that) { if (that.contains(this)) { diff --git a/api/src/main/java/net/kyori/adventure/util/ShadyPines.java b/api/src/main/java/net/kyori/adventure/util/ShadyPines.java index 7e233cf18..bcd5049a7 100644 --- a/api/src/main/java/net/kyori/adventure/util/ShadyPines.java +++ b/api/src/main/java/net/kyori/adventure/util/ShadyPines.java @@ -24,6 +24,8 @@ package net.kyori.adventure.util; import java.util.Set; + +import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; /** @@ -45,6 +47,7 @@ private ShadyPines() { * @deprecated for removal since 4.8.0, use {@link MonkeyBars#enumSet(Class, Enum[])} * @since 4.0.0 */ + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated @SafeVarargs @SuppressWarnings("varargs") diff --git a/text-serializer-plain/src/main/java/net/kyori/adventure/text/serializer/plain/PlainComponentSerializer.java b/text-serializer-plain/src/main/java/net/kyori/adventure/text/serializer/plain/PlainComponentSerializer.java index fb897b02d..71da955b8 100644 --- a/text-serializer-plain/src/main/java/net/kyori/adventure/text/serializer/plain/PlainComponentSerializer.java +++ b/text-serializer-plain/src/main/java/net/kyori/adventure/text/serializer/plain/PlainComponentSerializer.java @@ -33,6 +33,7 @@ import net.kyori.adventure.text.flattener.ComponentFlattener; import net.kyori.adventure.text.serializer.ComponentSerializer; import net.kyori.adventure.util.Buildable; +import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -45,6 +46,7 @@ * @deprecated for removal since 4.8.0, use {@link PlainTextComponentSerializer} instead * @since 4.0.0 */ +@ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated public class PlainComponentSerializer implements ComponentSerializer, Buildable { /** @@ -54,6 +56,7 @@ public class PlainComponentSerializer implements ComponentSerializer keybind, final @Nullable Function translatable) { this(PlainComponentSerializerImpl.createRealSerializerFromLegacyFunctions(keybind, translatable)); @@ -120,6 +126,7 @@ public PlainComponentSerializer(final @Nullable Function { /** @@ -148,6 +156,7 @@ public interface Builder extends Buildable.Builder { * @deprecated for removal since 4.8.0, use {@link PlainTextComponentSerializer.Builder#flattener(ComponentFlattener)} instead * @since 4.7.0 */ + @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0") @Deprecated @NotNull Builder flattener(final @NotNull ComponentFlattener flattener); } From 3204638840dd6775263acdcc74239db99ffb14aa Mon Sep 17 00:00:00 2001 From: Noah van der Aa Date: Wed, 22 Sep 2021 22:52:37 +0200 Subject: [PATCH 3/3] api: No newline --- api/src/main/java/net/kyori/adventure/util/ShadyPines.java | 1 - 1 file changed, 1 deletion(-) diff --git a/api/src/main/java/net/kyori/adventure/util/ShadyPines.java b/api/src/main/java/net/kyori/adventure/util/ShadyPines.java index bcd5049a7..1007c1e23 100644 --- a/api/src/main/java/net/kyori/adventure/util/ShadyPines.java +++ b/api/src/main/java/net/kyori/adventure/util/ShadyPines.java @@ -24,7 +24,6 @@ package net.kyori.adventure.util; import java.util.Set; - import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull;