From 8d0298693705320ada8692c6e62e83fe2c4009ed Mon Sep 17 00:00:00 2001 From: zml Date: Sun, 14 May 2023 17:42:27 -0700 Subject: [PATCH] chore(text-serializer-json): fix style errors and rebase issus --- .../main/java/net/kyori/adventure/util/Services.java | 4 ++-- .../gson/JsonComponentSerializerProviderImpl.java | 2 +- .../text/serializer/json/JsonComponentConstants.java | 2 +- .../text/serializer/json/JsonComponentSerializer.java | 8 ++++---- .../serializer/json/JsonComponentSerializerImpl.java | 4 ++-- .../adventure/text/serializer/json/package-info.java | 4 ++++ .../serializer/json/JsonComponentSerializerTest.java | 1 + .../adventure/text/serializer/json/SerializerTest.java | 10 +++++----- 8 files changed, 20 insertions(+), 15 deletions(-) create mode 100644 text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/package-info.java diff --git a/api/src/main/java/net/kyori/adventure/util/Services.java b/api/src/main/java/net/kyori/adventure/util/Services.java index b0384f770..b1ca003be 100644 --- a/api/src/main/java/net/kyori/adventure/util/Services.java +++ b/api/src/main/java/net/kyori/adventure/util/Services.java @@ -76,7 +76,7 @@ private Services() { *

When used in tandem with {@link #serviceWithFallback(Class)}, classes that implement this interface * will be ignored in favour of classes that do not implement this interface.

* - * @since 4.13.0 + * @since 4.14.0 */ public interface Fallback { } @@ -89,8 +89,8 @@ public interface Fallback { * @param type the service type * @param

the service type * @return a service, or {@link Optional#empty()} - * @since 4.13.0 * @see Fallback + * @since 4.14.0 */ public static

@NotNull Optional

serviceWithFallback(final @NotNull Class

type) { final ServiceLoader

loader = Services0.loader(type); diff --git a/text-serializer-gson/src/main/java/net/kyori/adventure/text/serializer/gson/JsonComponentSerializerProviderImpl.java b/text-serializer-gson/src/main/java/net/kyori/adventure/text/serializer/gson/JsonComponentSerializerProviderImpl.java index 632a90e16..cb5931fb1 100644 --- a/text-serializer-gson/src/main/java/net/kyori/adventure/text/serializer/gson/JsonComponentSerializerProviderImpl.java +++ b/text-serializer-gson/src/main/java/net/kyori/adventure/text/serializer/gson/JsonComponentSerializerProviderImpl.java @@ -31,7 +31,7 @@ /** * Implementation of the JSON component serializer provider. * - * @since 4.13.0 + * @since 4.14.0 */ @ApiStatus.Internal public final class JsonComponentSerializerProviderImpl implements JsonComponentSerializer.Provider, Services.Fallback { diff --git a/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentConstants.java b/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentConstants.java index 88641343b..67a22ebea 100644 --- a/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentConstants.java +++ b/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentConstants.java @@ -28,7 +28,7 @@ /** * Constants to aid in the creation and testing of JSON component serializers. * - * @since 4.13.0 + * @since 4.14.0 */ @ApiStatus.Internal public final class JsonComponentConstants { diff --git a/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializer.java b/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializer.java index fe75d92ed..40a2fb898 100644 --- a/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializer.java +++ b/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializer.java @@ -32,14 +32,14 @@ /** * A JSON component serializer. * - * @since 4.13.0 + * @since 4.14.0 */ public interface JsonComponentSerializer extends ComponentSerializer { /** * Gets a component serializer for JSON serialization and deserialization. * * @return a JSON component serializer - * @since 4.13.0 + * @since 4.14.0 */ static @NotNull JsonComponentSerializer json() { return JsonComponentSerializerImpl.Instances.INSTANCE; @@ -48,7 +48,7 @@ public interface JsonComponentSerializer extends ComponentSerializer SERVICE = Services.serviceWithFallback(Provider.class); @Override - public @NotNull Component deserialize(@NotNull String input) { + public @NotNull Component deserialize(final @NotNull String input) { throw new UnsupportedOperationException("No JsonComponentSerializer implementation found"); } @Override - public @NotNull String serialize(@NotNull Component component) { + public @NotNull String serialize(final @NotNull Component component) { throw new UnsupportedOperationException("No JsonComponentSerializer implementation found"); } diff --git a/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/package-info.java b/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/package-info.java new file mode 100644 index 000000000..651ec8e6f --- /dev/null +++ b/text-serializer-json/src/main/java/net/kyori/adventure/text/serializer/json/package-info.java @@ -0,0 +1,4 @@ +/** + * A common abstraction providing an API to serializer components with multiple JSON libraries. + */ +package net.kyori.adventure.text.serializer.json; diff --git a/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializerTest.java b/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializerTest.java index d92107c87..801869f97 100644 --- a/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializerTest.java +++ b/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/JsonComponentSerializerTest.java @@ -61,6 +61,7 @@ void testDeserializeArray() { ) ); } + // https://github.com/KyoriPowered/adventure/issues/414 @Test @SuppressWarnings("deprecation") diff --git a/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/SerializerTest.java b/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/SerializerTest.java index 33477976d..7a1b2d75f 100644 --- a/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/SerializerTest.java +++ b/text-serializer-json/src/testFixtures/java/net/kyori/adventure/text/serializer/json/SerializerTest.java @@ -50,7 +50,7 @@ final Component deserialize(final JsonElement json) { } final void testStyle(final Style style, final Consumer consumer) { - testObject(Component.text("", style), object -> { + this.testObject(Component.text("", style), object -> { object.addProperty(JsonComponentConstants.TEXT, ""); consumer.accept(object); }); @@ -59,15 +59,15 @@ final void testStyle(final Style style, final Consumer consu final void testArray(final Component component, final Consumer consumer) { final JsonArray json = array(consumer); - assertEquals(json, serialize(component)); - assertEquals(component, deserialize(json)); + assertEquals(json, this.serialize(component)); + assertEquals(component, this.deserialize(json)); } final void testObject(final Component component, final Consumer consumer) { final JsonObject json = object(consumer); - assertEquals(json, serialize(component)); - assertEquals(component, deserialize(json)); + assertEquals(json, this.serialize(component)); + assertEquals(component, this.deserialize(json)); } static JsonArray array(final Consumer consumer) {