Replace noFallback property with SuppressWarnings annotation

nbbrd · Feb 5, 2024 · cb0bc8a · cb0bc8a
1 parent cebe9a8
commit cb0bc8a
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add mustache templating in loader and batch names [#320](https://github.com/nbbrd/java-service-util/issues/320)
 
+### Changed
+
+- Replace noFallback property with SuppressWarnings annotation [#321](https://github.com/nbbrd/java-service-util/issues/321)
+
 ## [1.8.0] - 2024-01-31
 
 ### Added

diff --git a/java-service-annotation/src/main/java/nbbrd/service/ServiceDefinition.java b/java-service-annotation/src/main/java/nbbrd/service/ServiceDefinition.java
@@ -99,7 +99,9 @@
      * Specifies if fallback class is unexpected.
      *
      * @return true if fallback class is expected, false otherwise
+     * @deprecated Use {@link #SINGLE_FALLBACK_NOT_EXPECTED} instead
      */
+    @Deprecated
     boolean noFallback() default false;
 
     /**
@@ -227,4 +229,9 @@ public void accept(Iterable serviceLoader) {
             ((ServiceLoader) serviceLoader).reload();
         }
     }
+
+    /**
+     * Name to suppress single-fallback warning using @{@link SuppressWarnings}
+     */
+    String SINGLE_FALLBACK_NOT_EXPECTED = "SingleFallbackNotExpected";
 }
diff --git a/...e-processor/src/main/java/internal/nbbrd/service/definition/ServiceDefinitionChecker.java b/...e-processor/src/main/java/internal/nbbrd/service/definition/ServiceDefinitionChecker.java
@@ -32,10 +32,7 @@
 import javax.lang.model.util.Types;
 import javax.tools.Diagnostic;
 import java.io.IOException;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Optional;
+import java.util.*;
 import java.util.regex.Pattern;
 import java.util.regex.PatternSyntaxException;
 
@@ -168,7 +165,7 @@ public boolean checkDefinition(LoadDefinition definition) {
         Types types = env.getTypeUtils();
         TypeElement service = env.asTypeElement(definition.getServiceType());
 
-        if (!checkFallback(definition.getQuantifier(), definition.getFallback(), definition.isNoFallback(), service, types)) {
+        if (!checkFallback(definition.getQuantifier(), definition.getFallback(), definition.isNoFallback() || isSingleFallbackNotExpected(service), service, types)) {
             return false;
         }
         if (!checkWrapper(definition.getWrapper(), service, types)) {
@@ -347,4 +344,9 @@ private static boolean isValidPattern(String value) {
             return false;
         }
     }
+
+    private static boolean isSingleFallbackNotExpected(TypeElement service) {
+        SuppressWarnings annotation = service.getAnnotation(SuppressWarnings.class);
+        return annotation != null && Arrays.asList(annotation.value()).contains(ServiceDefinition.SINGLE_FALLBACK_NOT_EXPECTED);
+    }
 }
diff --git a/...essor/src/test/java/internal/nbbrd/service/definition/ServiceDefinitionProcessorTest.java b/...essor/src/test/java/internal/nbbrd/service/definition/ServiceDefinitionProcessorTest.java
@@ -775,6 +775,20 @@ public void testUnexpected() {
                     .singleElement()
                     .has(sourceFileNamed("definition", "TestFallbackUnexpectedLoader.java"));
         }
+
+        @Test
+        public void testSuppressWarning() {
+            JavaFileObject file = forResource("definition/TestFallbackSuppressWarning.java");
+            Compilation compilation = compile(file);
+
+            assertThat(compilation)
+                    .has(succeededWithoutWarnings());
+
+            assertThat(compilation)
+                    .extracting(Compilation::generatedSourceFiles, JAVA_FILE_OBJECTS)
+                    .singleElement()
+                    .has(sourceFileNamed("definition", "TestFallbackSuppressWarningLoader.java"));
+        }
     }
 
     @Nested

diff --git a/java-service-processor/src/test/resources/definition/TestFallbackSuppressWarning.java b/java-service-processor/src/test/resources/definition/TestFallbackSuppressWarning.java
@@ -0,0 +1,10 @@
+package definition;
+
+import static nbbrd.service.Quantifier.*;
+import nbbrd.service.ServiceDefinition;
+
+@SuppressWarnings(ServiceDefinition.SINGLE_FALLBACK_NOT_EXPECTED)
+@ServiceDefinition(quantifier = SINGLE)
+interface TestFallbackSuppressWarning {
+
+}