fix: adjust checkstyle checks on KeyPattern to match annotation

For some reason @pattern is not TYPE_USE, so we should adjust CS to match
KyoriPowered · Oct 3, 2024 · e6c7612 · e6c7612
1 parent 287bc90
commit e6c7612
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/.checkstyle/checkstyle.xml b/.checkstyle/checkstyle.xml
@@ -275,7 +275,7 @@
 
     <!-- https://gitlab.com/stellardrift/stylecheck/-/blob/trunk/src/main/java/ca/stellardrift/stylecheck/AnnotationsCloseToType.java -->
     <module name="AnnotationsCloseToType">
-      <property name="typeUseAnnotations" value="NotNull, Nullable, Pattern, RegExp, KeyPattern, KeyPattern.Namespace, KeyPattern.Value"/>
+      <property name="typeUseAnnotations" value="NotNull, Nullable, RegExp"/>
     </module>
 
     <!-- https://checkstyle.org/config_javadoc.html#WriteTag -->

diff --git a/key/src/main/java/net/kyori/adventure/key/Key.java b/key/src/main/java/net/kyori/adventure/key/Key.java
@@ -84,7 +84,7 @@ public interface Key extends Comparable<Key>, Examinable, Namespaced, Keyed {
    * @throws InvalidKeyException if the namespace or value contains an invalid character
    * @since 4.0.0
    */
-  static @NotNull Key key(final @NotNull @KeyPattern String string) {
+  static @NotNull Key key(@KeyPattern final @NotNull String string) {
     return key(string, DEFAULT_SEPARATOR);
   }
 
@@ -120,7 +120,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
    */
-  static @NotNull Key key(final @NotNull Namespaced namespaced, final @NotNull @KeyPattern.Value String value) {
+  static @NotNull Key key(final @NotNull Namespaced namespaced, @KeyPattern.Value final @NotNull String value) {
     return key(namespaced.namespace(), value);
   }
 
@@ -133,7 +133,7 @@ public interface Key extends Comparable<Key>, Examinable, Namespaced, Keyed {
    * @throws InvalidKeyException if the namespace or value contains an invalid character
    * @since 4.0.0
    */
-  static @NotNull Key key(final @NotNull @KeyPattern.Namespace String namespace, final @NotNull @KeyPattern.Value String value) {
+  static @NotNull Key key(@KeyPattern.Namespace final @NotNull String namespace, @KeyPattern.Value final @NotNull String value) {
     return new KeyImpl(namespace, value);
   }
 

diff --git a/key/src/main/java/net/kyori/adventure/key/Namespaced.java b/key/src/main/java/net/kyori/adventure/key/Namespaced.java
@@ -37,5 +37,6 @@ public interface Namespaced {
    * @return the namespace
    * @since 4.4.0
    */
-  @NotNull @KeyPattern.Namespace String namespace();
+  @KeyPattern.Namespace
+  @NotNull String namespace();
 }