Properly annotate parameters for matcher classes

benwoo1110 · benwoo1110 · commit 800709ca95f6 · 2025-08-11T12:43:38.000+08:00
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/matcher/ExactStringMatcher.java b/src/main/java/org/mvplugins/multiverse/core/utils/matcher/ExactStringMatcher.java
@@ -1,6 +1,8 @@
 package org.mvplugins.multiverse.core.utils.matcher;
 
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.Collection;
 import java.util.HashSet;
@@ -34,7 +36,7 @@ public ExactStringMatcher() {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    public ExactStringMatcher(String exactMatch) {
+    public ExactStringMatcher(@NotNull String exactMatch) {
         this.exactMatches = new HashSet<>();
         this.exactMatches.add(exactMatch);
     }
@@ -47,7 +49,7 @@ public ExactStringMatcher(String exactMatch) {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    public ExactStringMatcher(Collection<String> exactMatches) {
+    public ExactStringMatcher(@NotNull Collection<String> exactMatches) {
         this.exactMatches = new HashSet<>(exactMatches);
     }
 
@@ -59,15 +61,15 @@ public ExactStringMatcher(Collection<String> exactMatches) {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    public void addExactMatch(String value) {
+    public void addExactMatch(@NotNull String value) {
         this.exactMatches.add(value);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
-    public boolean matches(String value) {
+    public boolean matches(@Nullable String value) {
         return exactMatches.contains(value);
     }
 }
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/matcher/MatcherGroup.java b/src/main/java/org/mvplugins/multiverse/core/utils/matcher/MatcherGroup.java
@@ -2,6 +2,8 @@
 
 import com.dumptruckman.minecraft.util.Logging;
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -38,7 +40,7 @@ public MatcherGroup() {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    public MatcherGroup(Collection<String> matchStrings) {
+    public MatcherGroup(@NotNull Collection<String> matchStrings) {
         this();
         for (String matchString : matchStrings) {
             addMatcher(matchString);
@@ -53,7 +55,10 @@ public MatcherGroup(Collection<String> matchStrings) {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    public void addMatcher(String matchString) {
+    public void addMatcher(@Nullable String matchString) {
+        if (matchString == null || matchString.isEmpty()) {
+            return;
+        }
         if (isExact(matchString)) {
             Logging.warning("Exact: " + matchString);
             exactMatcher.addExactMatch(matchString);
@@ -62,7 +67,7 @@ public void addMatcher(String matchString) {
         }
     }
 
-    private boolean isExact(String matcherString) {
+    private boolean isExact(@NotNull String matcherString) {
         return !matcherString.contains("*") && !matcherString.startsWith("r=");
     }
 
@@ -74,15 +79,15 @@ private boolean isExact(String matcherString) {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    public void addMatcher(StringMatcher matcher) {
+    public void addMatcher(@NotNull StringMatcher matcher) {
         stringMatchers.add(matcher);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
-    public boolean matches(String value) {
+    public boolean matches(@Nullable String value) {
         if (exactMatcher.matches(value)) {
             return true;
         }
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/matcher/RegexStringMatcher.java b/src/main/java/org/mvplugins/multiverse/core/utils/matcher/RegexStringMatcher.java
@@ -48,9 +48,9 @@ private Pattern compileRegex(String regexString) {
      * {@inheritDoc}
      */
     @Override
-    public boolean matches(String value) {
-        if (regexPattern == null) {
-            return false; // If the regex pattern could not be compiled, we cannot match
+    public boolean matches(@Nullable String value) {
+        if (regexPattern == null || value == null) {
+            return false;
         }
         return regexPattern.matcher(value).matches();
     }
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/matcher/StringMatcher.java b/src/main/java/org/mvplugins/multiverse/core/utils/matcher/StringMatcher.java
@@ -1,6 +1,8 @@
 package org.mvplugins.multiverse.core.utils.matcher;
 
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.List;
 import java.util.stream.Collectors;
@@ -26,7 +28,7 @@ public interface StringMatcher {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    static StringMatcher fromString(String matcherString) {
+    static @NotNull StringMatcher fromString(@NotNull String matcherString) {
         if (matcherString.startsWith("r=")) {
             return new RegexStringMatcher(matcherString);
         } else if (matcherString.contains("*")) {
@@ -45,7 +47,7 @@ static StringMatcher fromString(String matcherString) {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    boolean matches(String value);
+    boolean matches(@Nullable String value);
 
     /**
      * Filters a list of strings, returning only those that match the pattern defined by this StringMatcher.
@@ -57,7 +59,7 @@ static StringMatcher fromString(String matcherString) {
      * @since 5.2
      */
     @ApiStatus.AvailableSince("5.2")
-    default List<String> filter(List<String> values) {
+    default @NotNull List<String> filter(@NotNull List<String> values) {
         return values.stream()
                 .filter(this::matches)
                 .collect(Collectors.toList());
diff --git a/src/main/java/org/mvplugins/multiverse/core/utils/matcher/WildcardStringMatcher.java b/src/main/java/org/mvplugins/multiverse/core/utils/matcher/WildcardStringMatcher.java
@@ -3,6 +3,8 @@
 import com.dumptruckman.minecraft.util.Logging;
 import io.vavr.control.Try;
 import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.regex.Pattern;
 
@@ -27,7 +29,7 @@ public class WildcardStringMatcher implements StringMatcher {
      * @param wildcard the wildcard string to match against.
      */
     @ApiStatus.AvailableSince("5.2")
-    public WildcardStringMatcher(String wildcard) {
+    public WildcardStringMatcher(@NotNull String wildcard) {
         this.wildcard = wildcard;
         this.pattern = Try.of(() -> Pattern.compile(("\\Q" + wildcard + "\\E").replace("*", "\\E.*\\Q")))
                 .onFailure(ex -> Logging.warning("Failed to compile wildcard '%s': %s",
@@ -39,7 +41,10 @@ public WildcardStringMatcher(String wildcard) {
      * {@inheritDoc}
      */
     @Override
-    public boolean matches(String value) {
+    public boolean matches(@Nullable String value) {
+        if (pattern == null || value == null) {
+            return false;
+        }
         return pattern.matcher(value).matches();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,9 @@ private Pattern compileRegex(String regexString) {`
`48`	`48`	`* {@inheritDoc}`
`49`	`49`	`*/`
`50`	`50`	`@Override`
`51`		`- public boolean matches(String value) {`
`52`		`- if (regexPattern == null) {`
`53`		`- return false; // If the regex pattern could not be compiled, we cannot match`
	`51`	`+ public boolean matches(@Nullable String value) {`
	`52`	`+ if (regexPattern == null \|\| value == null) {`
	`53`	`+ return false;`
`54`	`54`	`}`
`55`	`55`	`return regexPattern.matcher(value).matches();`
`56`	`56`	`}`