Added new Jandex methods

Author: michael-schnell

.checkstyle

@@ -9,7 +9,8 @@ A small Java library that contains several helpful utility classes.
 [![Java Development Kit 17](https://img.shields.io/badge/JDK-17-green.svg)](https://openjdk.java.net/projects/jdk/17/)
 
 ## Versions
-- 0.14.0 = See [release-notes](release-notes.md)
+- [0.15.0](release-notes.md#0150)
+- [0.14.0](release-notes.md#0140)
 - 0.13.x (or later) = **Java 17**
 - 0.12.0 = **Java 11** with new **jakarta** namespace
 - 0.11.x = **Java 11** before namespace change from 'javax' to 'jakarta'

README.md

@@ -12,7 +12,7 @@
 
     <artifactId>utils4j</artifactId>
     <packaging>bundle</packaging>
-    <version>0.14.0</version>
+    <version>0.15.0-SNAPSHOT</version>
     <description>A small Java library that contains several helpful utility classes.</description>
     <url>http://www.fuin.org/utils4j/</url>
 

pom.xml

@@ -1,5 +1,8 @@
 # Release Notes
 
+## 0.15.0
+- Added new [JandexUtils](src/main/java/org/fuin/utils4j/jandex/JandexUtils.java) methods
+
 ## 0.14.0
 
 ### General

release-notes.md

@@ -18,14 +18,21 @@
 package org.fuin.utils4j.jandex;
 
 import org.fuin.utils4j.Utils4J;
+import org.jboss.jandex.ClassInfo;
+import org.jboss.jandex.CompositeIndex;
 import org.jboss.jandex.DotName;
 import org.jboss.jandex.Index;
+import org.jboss.jandex.IndexView;
 import org.jboss.jandex.Indexer;
 
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Modifier;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.Enumeration;
 import java.util.List;
 import java.util.jar.JarEntry;
@@ -84,6 +91,21 @@ public static Index indexDir(final File dir) {
         return indexer.complete();
     }
 
+    /**
+     * Indexes all classes in multiple directories and their subdirectories.
+     *
+     * @param dirs Classes directories to analyze.
+     * @return Index of all classes in the directories.
+     */
+    public static Index indexDirs(final File... dirs) {
+        final Indexer indexer = new Indexer();
+        final List<File> knownClassFiles = new ArrayList<>();
+        for (final File dir : dirs) {
+            indexDir(indexer, knownClassFiles, dir);
+        }
+        return indexer.complete();
+    }
+
     /**
      * Indexes all classes in a directory or it's subdirectories.
      * 
@@ -194,5 +216,43 @@ public static Class<?> loadClass(DotName name) {
         return Utils4J.loadClass(name.toString());
     }
 
+    /**
+     * Locates (non-abstract, non-interface) classes that implement a given interface in directories.
+     *
+     * @param intf Interface to find implementors for.
+     * @param classesDirs Directories with class files to scan.
+     * @return List of classes.
+     *
+     * @param <T> Expected interface type.
+     */
+    @SuppressWarnings("unchecked")
+    public static <T> List<Class<? extends T>> findImplementors(final Class<T> intf, final File... classesDirs) {
+        final List<IndexView> indexes = new ArrayList<>();
+        indexes.add(new JandexIndexFileReader.Builder().addDefaultResource().build().loadR());
+        indexes.add(indexDirs(classesDirs));
+        return findImplementors(intf, CompositeIndex.create(indexes));
+    }
+
+    /**
+     * Locates (non-abstract, non-interface) classes that implement a given interface in an index.
+     *
+     * @param intf Interface to find implementors for.
+     * @param index Index with known classes.
+     * @return List of classes.
+     *
+     * @param <T> Expected interface type.
+     */
+    @SuppressWarnings("unchecked")
+    public static <T> List<Class<? extends T>> findImplementors(final Class<T> intf, final IndexView index) {
+        List<Class<? extends T>> implementors = new ArrayList<>();
+        final Collection<ClassInfo> implementingClasses = index.getAllKnownImplementors(DotName.createSimple(intf));
+        for (final ClassInfo classInfo : implementingClasses) {
+            if (!Modifier.isAbstract(classInfo.flags()) && !Modifier.isInterface(classInfo.flags())) {
+                final Class<? extends T> implementor = (Class<? extends T>) JandexUtils.loadClass(classInfo.name());
+                implementors.add(implementor);
+            }
+        }
+        return implementors;
+    }
 
 }

src/main/java/org/fuin/utils4j/jandex/JandexUtils.java

@@ -18,7 +18,10 @@
 package org.fuin.utils4j.jandex;
 
 import org.fuin.utils4j.Utils4J;
+import org.fuin.utils4j.filter.AndFilter;
+import org.fuin.utils4j.filter.Filter;
 import org.fuin.utils4j.jandex.JandexUtils;
+import org.fuin.utils4j.jaxb.CDataXmlAdapter;
 import org.jboss.jandex.DotName;
 import org.jboss.jandex.Index;
 import org.jboss.jandex.Indexer;
@@ -73,6 +76,22 @@ public final void testIndexDirSimple() {
 
     }
 
+    @Test
+    public final void testIndexDirs() {
+
+        // PREPEARE
+        final File filterDir = new File(TARGET_DIR, "classes/org/fuin/utils4j/filter");
+        final File jaxbDir = new File(TARGET_DIR, "classes/org/fuin/utils4j/jaxb");
+
+        // TEST
+        final Index index = JandexUtils.indexDirs(filterDir, jaxbDir);
+
+        // VERIFY
+        assertThat(index.getClassByName(DotName.createSimple(AndFilter.class.getName()))).isNotNull();
+        assertThat(index.getClassByName(DotName.createSimple(CDataXmlAdapter.class.getName()))).isNotNull();
+
+    }
+
     @Test
     public final void testIndexDir() {
 
@@ -145,5 +164,20 @@ public final void loadClassFailure() {
                 .hasMessageContaining("Failed to load class");
     }
 
+    @Test
+    public final void findImplementors() {
+
+        // PREPEARE
+        final File filterDir = new File(TARGET_DIR, "classes/org/fuin/utils4j/filter");
+
+        // TEST
+        final List<Class<? extends Filter>> classes = JandexUtils.findImplementors(Filter.class, filterDir);
+
+        // VERIFY
+        assertThat(classes).isNotEmpty();
+        assertThat(classes).contains(AndFilter.class);
+
+    }
+
 }
 // CHECKSTYLE:ON