FastClasspathScanner

FastClasspathScanner is an uber-fast, ultra-lightweight classpath scanner for Java, Scala and other JVM languages.

What is classpath scanning? Classpath scanning involves scanning directories and jar/zip files on the classpath to find files (especially classfiles) that meet certain criteria. In many ways, classpath scanning offers the inverse of the Java reflection API: the Java reflection API can tell you the superclass of a given class, but classpath scanning can find all classes that extend a given superclass. The Java reflection API can give you the list of annotations on a given class, but classpath scanning can find all classes that are annotated with a given annotation. (etc.)

Version 2.0 has been released, with multithreaded scanning for extra speed. (Release notes)

FastClasspathScanner is able to:

Find classes that subclass/extend a given class.
Find classes that implement an interface or one of its subinterfaces, or whose superclasses implement the interface or one of its subinterfaces.
Find interfaces that extend a given interface or one of its subinterfaces.
Find classes that have a specific class annotation or meta-annotation.
Find classes that have methods with a given annotation.
Find all classes that contain a field of a given type (including identifying fields based on array element type and generic parameter type);
Read the constant literal initializer value in a classfile's constant pool for a specified static final field;
Find files (even non-classfiles) anywhere on the classpath that have a path that matches a given string or regular expression.
Return a list of the names of all classes, interfaces and/or annotations on the classpath (after whitelist and blacklist filtering).
Return a list of all directories and files on the classpath (i.e. all classpath elements) as a list of File objects, with the list deduplicated and filtered to include only classpath directories and files that actually exist, saving you from the complexities of working with the classpath and classloaders.
Detect changes to the files within the classpath since the first time the classpath was scanned.
Generate a GraphViz .dot file from the class graph for visualization purposes, as shown below. A class graph visualizatoin depicts connections between classes, interfaces, annotations and meta-annotations, and connections between classes and the types of their fields.

Documentation

See the wiki for full documentation.

Mailing List

Feel free to subscribe to the FastClasspathScanner-Users email list for updates, or to ask questions.

Downloading

Use the "Clone or download" button at the top right of this page to get the source. You can get a pre-built JAR (usable in JRE 1.7 or later) from Sonatype, or add the following Maven Central dependency:

<dependency>
    <groupId>io.github.lukehutch</groupId>
    <artifactId>fast-classpath-scanner</artifactId>
    <version>LATEST</version>
</dependency>

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fleipold / fast-classpath-scanner Goto Github PK