chore(key): Refactor module to remove deprecations and use modern language features

Author: kezz

key/src/main/java/net/kyori/adventure/key/InvalidKeyException.java

@@ -23,6 +23,7 @@
  */
 package net.kyori.adventure.key;
 
+import java.io.Serial;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -32,6 +33,7 @@
  * @since 4.0.0
  */
 public final class InvalidKeyException extends RuntimeException {
+  @Serial
   private static final long serialVersionUID = -5413304087321449434L;
   private final String keyNamespace;
   private final String keyValue;
@@ -48,7 +50,7 @@ public final class InvalidKeyException extends RuntimeException {
    * @return a key
    * @since 4.0.0
    */
-  public final @NotNull String keyNamespace() {
+  public @NotNull String keyNamespace() {
     return this.keyNamespace;
   }
 
@@ -58,7 +60,7 @@ public final class InvalidKeyException extends RuntimeException {
    * @return a key
    * @since 4.0.0
    */
-  public final @NotNull String keyValue() {
+  public @NotNull String keyValue() {
     return this.keyValue;
   }
 }

key/src/main/java/net/kyori/adventure/key/Key.java

@@ -122,6 +122,7 @@ public interface Key extends Comparable<Key>, Examinable, Namespaced, Keyed {
    * @throws InvalidKeyException if the namespace or value contains an invalid character
    * @since 4.4.0
    */
+  @SuppressWarnings("PatternValidation") // The namespace is tested later.
   static @NotNull Key key(final @NotNull Namespaced namespaced, @KeyPattern.Value final @NotNull String value) {
     return key(Objects.requireNonNull(namespaced, "namespaced").namespace(), value);
   }
@@ -136,6 +137,8 @@ public interface Key extends Comparable<Key>, Examinable, Namespaced, Keyed {
    * @since 4.0.0
    */
   static @NotNull Key key(@KeyPattern.Namespace final @NotNull String namespace, @KeyPattern.Value final @NotNull String value) {
+    KeyImpl.checkError("namespace", namespace, namespace, value, Key.checkNamespace(namespace), KeyImpl.NAMESPACE_PATTERN);
+    KeyImpl.checkError("value", value, namespace, value, Key.checkValue(value), KeyImpl.VALUE_PATTERN);
     return new KeyImpl(namespace, value);
   }
 
@@ -176,7 +179,7 @@ static boolean parseable(final @Nullable String string) {
    * @since 4.12.0
    */
   static boolean parseableNamespace(final @NotNull String namespace) {
-    return !checkNamespace(namespace).isPresent();
+    return checkNamespace(namespace).isEmpty();
   }
 
   /**
@@ -204,7 +207,7 @@ static boolean parseableNamespace(final @NotNull String namespace) {
    * @since 4.12.0
    */
   static boolean parseableValue(final @NotNull String value) {
-    return !checkValue(value).isPresent();
+    return checkValue(value).isEmpty();
   }
 
   /**

key/src/main/java/net/kyori/adventure/key/KeyImpl.java

@@ -35,23 +35,14 @@
 
 import static java.util.Objects.requireNonNull;
 
-final class KeyImpl implements Key {
+record KeyImpl(String namespace, String value) implements Key {
   static final Comparator<? super Key> COMPARATOR = Comparator.comparing(Key::value).thenComparing(Key::namespace);
 
   static final @RegExp String NAMESPACE_PATTERN = "[a-z0-9_\\-.]+";
   static final @RegExp String VALUE_PATTERN = "[a-z0-9_\\-./]+";
 
-  private final String namespace;
-  private final String value;
-
-  KeyImpl(final @NotNull String namespace, final @NotNull String value) {
-    checkError("namespace", namespace, namespace, value, Key.checkNamespace(namespace), NAMESPACE_PATTERN);
-    checkError("value", value, namespace, value, Key.checkValue(value), VALUE_PATTERN);
-    this.namespace = requireNonNull(namespace, "namespace");
-    this.value = requireNonNull(value, "value");
-  }
-
-  private static void checkError(final String name, final String checkPart, final String namespace, final String value, final OptionalInt index, final String pattern) {
+  static void checkError(final String name, final String checkPart, final String namespace, final String value, final OptionalInt index, final String pattern) {
+    requireNonNull(checkPart, name);
     if (index.isPresent()) {
       final int indexValue = index.getAsInt();
       final char character = checkPart.charAt(indexValue);
@@ -74,16 +65,6 @@ static boolean allowedInValue(final char character) {
     return character == '_' || character == '-' || (character >= 'a' && character <= 'z') || (character >= '0' && character <= '9') || character == '.' || character == '/';
   }
 
-  @Override
-  public @NotNull String namespace() {
-    return this.namespace;
-  }
-
-  @Override
-  public @NotNull String value() {
-    return this.value;
-  }
-
   @Override
   public @NotNull String asString() {
     return asString(this.namespace, this.value);
@@ -109,18 +90,10 @@ static boolean allowedInValue(final char character) {
   @Override
   public boolean equals(final Object other) {
     if (this == other) return true;
-    if (!(other instanceof Key)) return false;
-    final Key that = (Key) other;
+    if (!(other instanceof Key that)) return false;
     return Objects.equals(this.namespace, that.namespace()) && Objects.equals(this.value, that.value());
   }
 
-  @Override
-  public int hashCode() {
-    int result = this.namespace.hashCode();
-    result = (31 * result) + this.value.hashCode();
-    return result;
-  }
-
   @Override
   public int compareTo(final @NotNull Key that) {
     return Key.super.compareTo(that);

key/src/main/java/net/kyori/adventure/key/KeyedValue.java

@@ -23,7 +23,6 @@
  */
 package net.kyori.adventure.key;
 
-import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 import static java.util.Objects.requireNonNull;
@@ -48,22 +47,6 @@ public interface KeyedValue<T> extends Keyed {
     return new KeyedValueImpl<>(key, requireNonNull(value, "value"));
   }
 
-  /**
-   * Creates a link.
-   *
-   * @param key the key
-   * @param value the value
-   * @param <T> the value type
-   * @return the keyed
-   * @since 4.0.0
-   * @deprecated for removal since 4.10.0, use {@link #keyedValue(Key, Object)} instead.
-   */
-  @Deprecated
-  @ApiStatus.ScheduledForRemoval(inVersion = "5.0.0")
-  static <T> @NotNull KeyedValue<T> of(final @NotNull Key key, final @NotNull T value) {
-    return new KeyedValueImpl<>(key, requireNonNull(value, "value"));
-  }
-
   /**
    * Gets the value.
    *

key/src/main/java/net/kyori/adventure/key/KeyedValueImpl.java

@@ -30,38 +30,13 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-final class KeyedValueImpl<T> implements Examinable, KeyedValue<T> {
-  private final Key key;
-  private final T value;
-
-  KeyedValueImpl(final Key key, final T value) {
-    this.key = key;
-    this.value = value;
-  }
-
-  @Override
-  public @NotNull Key key() {
-    return this.key;
-  }
-
-  @Override
-  public @NotNull T value() {
-    return this.value;
-  }
+record KeyedValueImpl<T>(Key key, T value) implements Examinable, KeyedValue<T> {
 
   @Override
   public boolean equals(final @Nullable Object other) {
     if (this == other) return true;
-    if (other == null || this.getClass() != other.getClass()) return false;
-    final KeyedValueImpl<?> that = (KeyedValueImpl<?>) other;
-    return this.key.equals(that.key) && this.value.equals(that.value);
-  }
-
-  @Override
-  public int hashCode() {
-    int result = this.key.hashCode();
-    result = (31 * result) + this.value.hashCode();
-    return result;
+    if (!(other instanceof KeyedValue<?> that)) return false;
+    return this.key.equals(that.key()) && this.value.equals(that.value());
   }
 
   @Override
@@ -73,7 +48,7 @@ public int hashCode() {
   }
 
   @Override
-  public String toString() {
+  public @NotNull String toString() {
     return this.examine(StringExaminer.simpleEscaping());
   }
 }

key/src/test/java/net/kyori/adventure/key/KeyTest.java

@@ -53,6 +53,7 @@ void testOfNamespaceAndValueParsed() {
     assertEquals("empty", key.value());
   }
 
+  @SuppressWarnings("PatternValidation") // We are testing to ensure this throws an exception.
   @Test
   void testOfInvalid() {
     assertEquals("!", assertThrows(InvalidKeyException.class, () -> Key.key("!")).keyValue());
@@ -115,6 +116,7 @@ void testParseableValue() {
     assertTrue(Key.parseableValue("some/path"));
   }
 
+  @SuppressWarnings("PatternValidation") // We are testing to ensure this throws an exception.
   @Test
   void testNulChar() {
     assertThrows(InvalidKeyException.class, () -> Key.key("carbon:global\0\0\0"));
@@ -125,6 +127,7 @@ void testParseWithEmptyNamespace() {
     assertEquals(Key.key(Key.MINECRAFT_NAMESPACE, "test"), Key.key(":test"));
   }
 
+  @SuppressWarnings("PatternValidation") // We are testing to ensure this throws an exception.
   @Test
   void testKeyWithInvalidCharacter() {
     assertThrows(InvalidKeyException.class, () -> Key.key("a/b", "a"));