(daffodil) branch main updated: Add Validators.list() API

[slawrence]

This is an automated email from the ASF dual-hosted git repository.

slawrence pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil.git


The following commit(s) were added to refs/heads/main by this push:
     new f072b4b18 Add Validators.list() API
f072b4b18 is described below

commit f072b4b18695205181bd0be260063eea0d2da4a4
Author: Steve Lawrence <slawre...@apache.org>
AuthorDate: Wed Aug 27 07:39:17 2025 -0400

    Add Validators.list() API
    
    Allows listing names of all validators avilable via SPI.
    
    Also use the new function to improve the ValidatorNotRegisteredException
    to contain the list of available validators.
    
    DAFFODIL-3034
---
 .../api/validation/ValidatorNotRegisteredException.java    |  8 +++++++-
 .../org/apache/daffodil/api/validation/Validators.java     | 12 ++++++++++++
 .../apache/daffodil/lib/validation/TestValidatorsSPI.scala | 14 ++++++++++++++
 3 files changed, 33 insertions(+), 1 deletion(-)

diff --git 
a/daffodil-core/src/main/java/org/apache/daffodil/api/validation/ValidatorNotRegisteredException.java
 
b/daffodil-core/src/main/java/org/apache/daffodil/api/validation/ValidatorNotRegisteredException.java
index b257c818f..4495f4ccb 100644
--- 
a/daffodil-core/src/main/java/org/apache/daffodil/api/validation/ValidatorNotRegisteredException.java
+++ 
b/daffodil-core/src/main/java/org/apache/daffodil/api/validation/ValidatorNotRegisteredException.java
@@ -27,6 +27,12 @@ public class ValidatorNotRegisteredException extends 
Exception {
    * @param name the requested validator factory name
    */
   ValidatorNotRegisteredException(String name) {
-    super("No api.validation.ValidatorFactory is registered as " + name);
+    super(
+      String.format(
+        "No Daffodil ValidatorFactory is registered with name '%s'. Available 
validators: %s",
+        name,
+        String.join(", ", Validators.list())
+      )
+    );
   }
 }
diff --git 
a/daffodil-core/src/main/java/org/apache/daffodil/api/validation/Validators.java
 
b/daffodil-core/src/main/java/org/apache/daffodil/api/validation/Validators.java
index e24b4246b..e456bac4d 100644
--- 
a/daffodil-core/src/main/java/org/apache/daffodil/api/validation/Validators.java
+++ 
b/daffodil-core/src/main/java/org/apache/daffodil/api/validation/Validators.java
@@ -19,6 +19,9 @@ package org.apache.daffodil.api.validation;
 
 import org.apache.daffodil.lib.util.SimpleNamedServiceLoader;
 
+import java.util.List;
+import java.util.ArrayList;
+
 /**
  * Access SPI registered {@link 
org.apache.daffodil.api.validation.ValidatorFactory} instances.
  * <p>
@@ -71,4 +74,13 @@ public class Validators {
   public static boolean isRegistered(String name) {
     return impls.containsKey(name);
   }
+
+  /**
+   * Get a list of available validator names
+   *
+   * @return array of validator names
+   */
+  public static List<String> list() {
+    return new ArrayList<String>(impls.keySet());
+  }
 }
diff --git 
a/daffodil-core/src/test/scala/org/apache/daffodil/lib/validation/TestValidatorsSPI.scala
 
b/daffodil-core/src/test/scala/org/apache/daffodil/lib/validation/TestValidatorsSPI.scala
index 085b41e27..54689196a 100644
--- 
a/daffodil-core/src/test/scala/org/apache/daffodil/lib/validation/TestValidatorsSPI.scala
+++ 
b/daffodil-core/src/test/scala/org/apache/daffodil/lib/validation/TestValidatorsSPI.scala
@@ -21,6 +21,9 @@ import java.util.Properties
 
 import org.apache.daffodil.api.validation.ValidatorNotRegisteredException
 import org.apache.daffodil.api.validation.Validators
+import org.apache.daffodil.core.util.TestUtils.intercept
+import org.apache.daffodil.validation.DaffodilValidator
+import org.apache.daffodil.validation.NoValidator
 import org.apache.daffodil.validation.XercesValidator
 
 import org.junit.Assert.assertEquals
@@ -45,6 +48,10 @@ class TestValidatorsSPI {
 
   @Test def testValidatorNonExists(): Unit = {
     assertFalse(Validators.isRegistered("dont exist"))
+    val e = intercept[ValidatorNotRegisteredException] {
+      Validators.get("dont exist")
+    }
+    assertTrue(e.getMessage.contains("dont exist"))
   }
 
   @Test def testDefaultIsRegistered(): Unit = {
@@ -77,4 +84,11 @@ class TestValidatorsSPI {
 
     assertEquals(validationHandler.errors.head, "boom")
   }
+
+  @Test def testListValidators(): Unit = {
+    val vs = Validators.list()
+    assertTrue(vs.contains(NoValidator.name))
+    assertTrue(vs.contains(DaffodilValidator.name))
+    assertTrue(vs.contains(XercesValidator.name))
+  }
 }