Index (Fast Classpath Scanner 1.9.1 API)

A C F G H I L M O P R S T U V

A

addFilePathMatcher(RecursiveScanner.FilePathMatcher) - Method in class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner
addStaticFinalFieldProcessor(String, String, StaticFinalFieldMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Add a StaticFinalFieldMatchProcessor that should be called if a static final field with the given name is encountered in a class with the given fully-qualified classname while reading a classfile header.
annotationNames - Variable in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo

C

ClassAnnotationMatchProcessor - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when a class having a specified annotation is found on the classpath.
ClassfileBinaryParser - Class in io.github.lukehutch.fastclasspathscanner.classgraph
ClassfileBinaryParser() - Constructor for class io.github.lukehutch.fastclasspathscanner.classgraph.ClassfileBinaryParser
ClassGraphBuilder - Class in io.github.lukehutch.fastclasspathscanner.classgraph
ClassGraphBuilder(Collection<ClassInfo>) - Constructor for class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder
ClassInfo - Class in io.github.lukehutch.fastclasspathscanner.classgraph
ClassInfo(String) - Constructor for class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo
className - Variable in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo
classpathContentsLastModifiedTime() - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the maximum "last modified" timestamp in the classpath (in epoch millis), or zero if scan() has not yet been called (or if nothing was found on the classpath).
classpathContentsLastModifiedTime() - Method in class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner: Returns the maximum "last modified" timestamp in the classpath (in epoch millis), or zero if scan() has not yet been called (or if nothing was found on the classpath).
classpathContentsModifiedSinceScan() - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns true if the classpath contents have been changed since scan() was last called.
classpathContentsModifiedSinceScan() - Method in class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner: Returns true if the classpath contents have been changed since scan() was last called.
ClasspathFinder - Class in io.github.lukehutch.fastclasspathscanner.scanner
ClasspathFinder() - Constructor for class io.github.lukehutch.fastclasspathscanner.scanner.ClasspathFinder
clear() - Method in class io.github.lukehutch.fastclasspathscanner.utils.LazyMap

F

FastClasspathScanner - Class in io.github.lukehutch.fastclasspathscanner: Uber-fast, ultra-lightweight Java classpath scanner.
FastClasspathScanner(String...) - Constructor for class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Constructs a FastClasspathScanner instance.
FileMatchContentsProcessor - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when a file with a matching path is found on the classpath.
FileMatchProcessor - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when a file with a matching path is found on the classpath.
FilePathMatcher(RecursiveScanner.FilePathTester, FileMatchProcessor) - Constructor for class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner.FilePathMatcher
filePathMatches(String) - Method in class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner.FilePathMatcher
filePathMatches(String) - Method in interface io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner.FilePathTester

G

getClassNameToClassfileHash() - Method in class io.github.lukehutch.fastclasspathscanner.utils.HashClassfileContents: Returns the mapping from class name to hash of classfile contents after the call to .scan().
getNamesOfAllClasses() - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return names of all classes (including interfaces and annotations) reached during the scan.
getNamesOfAllClasses() - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of all classes and interfaces processed during the scan, i.e.
getNamesOfAnnotationsOnClass(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all annotations and meta-annotations on the named class.
getNamesOfAnnotationsOnClass(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Return the names of all annotations and meta-annotations on the specified class or interface.
getNamesOfAnnotationsOnClass(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Return the names of all annotations and meta-annotations on the specified class or interface.
getNamesOfAnnotationsWithMetaAnnotation(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all annotations that have the named meta-annotation.
getNamesOfAnnotationsWithMetaAnnotation(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Return the names of all annotations that are annotated with the specified meta-annotation.
getNamesOfAnnotationsWithMetaAnnotation(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Return the names of all annotations that are annotated with the specified meta-annotation.
getNamesOfClassesImplementing(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all classes implementing the named interface.
getNamesOfClassesImplementing(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface.
getNamesOfClassesImplementing(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface.
getNamesOfClassesImplementingAllOf(Class<?>...) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that implement (or have superclasses that implement) all of the specified interfaces or their subinterfaces.
getNamesOfClassesImplementingAllOf(String...) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that implement (or have superclasses that implement) all of the specified interfaces or their subinterfaces.
getNamesOfClassesWithAnnotation(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all classes with the named class annotation or meta-annotation.
getNamesOfClassesWithAnnotation(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that have the specified annotation.
getNamesOfClassesWithAnnotation(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that have the specified annotation.
getNamesOfClassesWithAnnotationsAllOf(Class<?>...) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that have all of the specified annotations.
getNamesOfClassesWithAnnotationsAllOf(String...) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that have all of the specified annotations.
getNamesOfClassesWithAnnotationsAnyOf(Class<?>...) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that have any of the specified annotations.
getNamesOfClassesWithAnnotationsAnyOf(String...) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that have any of the specified annotations.
getNamesOfMetaAnnotationsOnAnnotation(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all meta-annotations on the named annotation.
getNamesOfMetaAnnotationsOnAnnotation(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Return the names of all meta-annotations on the specified annotation.
getNamesOfMetaAnnotationsOnAnnotation(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Return the names of all meta-annotations on the specified annotation.
getNamesOfSubclassesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all subclasses of the named class.
getNamesOfSubclassesOf(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that extend the specified superclass.
getNamesOfSubclassesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that extend the specified superclass.
getNamesOfSubinterfacesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all subinterfaces of the named interface.
getNamesOfSubinterfacesOf(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of interfaces on the classpath that extend a given superinterface.
getNamesOfSubinterfacesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of interfaces on the classpath that extend a given superinterface.
getNamesOfSuperclassesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all superclasses of the named class.
getNamesOfSuperclassesOf(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that are superclasses of the specified subclass.
getNamesOfSuperclassesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of classes on the classpath that are superclasses of the specified subclass.
getNamesOfSuperinterfacesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassGraphBuilder: Return the names of all superinterfaces of the named interface.
getNamesOfSuperinterfacesOf(Class<?>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of interfaces on the classpath that are superinterfaces of a given subinterface.
getNamesOfSuperinterfacesOf(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Returns the names of interfaces on the classpath that are superinterfaces of a given subinterface.
getUniqueClasspathElements() - Method in class io.github.lukehutch.fastclasspathscanner.scanner.ClasspathFinder: Get a list of unique elements on the classpath (directories and files) as File objects, preserving order.

H

HashClassfileContents - Class in io.github.lukehutch.fastclasspathscanner.utils: An example wrapper for FastClasspathScanner that hashes the content of classfiles encontered on the classpath in order to enable more precise change detection than provided by timestamp checking.
HashClassfileContents(String...) - Constructor for class io.github.lukehutch.fastclasspathscanner.utils.HashClassfileContents

I

initialize() - Method in class io.github.lukehutch.fastclasspathscanner.utils.LazyMap
InterfaceMatchProcessor<T> - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when a class implementing a specific interface is found on the classpath.
interfaceNames - Variable in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo
invert(HashMap<K, ArrayList<V>>) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.MultiMap: Invert the mapping
invert(HashMap<K, HashSet<V>>) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.MultiSet: Invert the mapping
io.github.lukehutch.fastclasspathscanner - package io.github.lukehutch.fastclasspathscanner
io.github.lukehutch.fastclasspathscanner.classgraph - package io.github.lukehutch.fastclasspathscanner.classgraph
io.github.lukehutch.fastclasspathscanner.matchprocessor - package io.github.lukehutch.fastclasspathscanner.matchprocessor
io.github.lukehutch.fastclasspathscanner.scanner - package io.github.lukehutch.fastclasspathscanner.scanner
io.github.lukehutch.fastclasspathscanner.utils - package io.github.lukehutch.fastclasspathscanner.utils
isAnnotation - Variable in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo
isInterface - Variable in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo
isJar(String) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.Utils: Returns true if the path ends with a JAR extension

L

LazyMap<K,V> - Class in io.github.lukehutch.fastclasspathscanner.utils: Used to wrap a map with lazy evaluation, so work is not done unless it is needed.
LazyMap() - Constructor for class io.github.lukehutch.fastclasspathscanner.utils.LazyMap
loadClass(String) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Call the classloader using Class.forName(className).
Log - Class in io.github.lukehutch.fastclasspathscanner.utils
Log() - Constructor for class io.github.lukehutch.fastclasspathscanner.utils.Log
log(String) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.Log

M

map - Variable in class io.github.lukehutch.fastclasspathscanner.utils.LazyMap
matchClassesImplementing(Class<T>, InterfaceMatchProcessor<T>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the provided InterfaceMatchProcessor for classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface.
matchClassesWithAnnotation(Class<?>, ClassAnnotationMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the provided ClassMatchProcessor if classes are found on the classpath that have the specified annotation.
matchFilenameExtension(String, FileMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchProcessor if files are found on the classpath that have the given file extension.
matchFilenameExtension(String, FileMatchContentsProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchProcessor if files are found on the classpath that have the given file extension.
matchFilenamePath(String, FileMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchProcessor if files are found on the classpath that exactly match the given relative path.
matchFilenamePath(String, FileMatchContentsProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchContentsProcessor if files are found on the classpath that exactly match the given relative path.
matchFilenamePathLeaf(String, FileMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchProcessor if files are found on the classpath that exactly match the given path leafname.
matchFilenamePathLeaf(String, FileMatchContentsProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchContentsProcessor if files are found on the classpath that exactly match the given path leafname.
matchFilenamePattern(String, FileMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchProcessor if files are found on the classpath with the given regexp pattern in their path.
matchFilenamePattern(String, FileMatchContentsProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given FileMatchContentsProcessor if files are found on the classpath with the given regexp pattern in their path.
matchStaticFinalFieldNames(HashSet<String>, StaticFinalFieldMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match one of a set of fully-qualified field names, e.g.
matchStaticFinalFieldNames(String, StaticFinalFieldMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match a fully-qualified field name, e.g.
matchStaticFinalFieldNames(String[], StaticFinalFieldMatchProcessor) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the given StaticFinalFieldMatchProcessor if classes are found on the classpath that contain static final fields that match one of a list of fully-qualified field names, e.g.
matchSubclassesOf(Class<T>, SubclassMatchProcessor<T>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the provided SubclassMatchProcessor if classes are found on the classpath that extend the specified superclass.
matchSubinterfacesOf(Class<T>, SubinterfaceMatchProcessor<T>) - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Calls the provided SubinterfaceMatchProcessor if an interface that extends a given superinterface is found on the classpath.
MultiMap - Class in io.github.lukehutch.fastclasspathscanner.utils: Multimap utility functions.
MultiMap() - Constructor for class io.github.lukehutch.fastclasspathscanner.utils.MultiMap
MultiSet - Class in io.github.lukehutch.fastclasspathscanner.utils: Multiset utility functions.
MultiSet() - Constructor for class io.github.lukehutch.fastclasspathscanner.utils.MultiSet

O

overrideClasspath(String) - Method in class io.github.lukehutch.fastclasspathscanner.scanner.ClasspathFinder: Override the system classpath with a custom classpath to search.

P

processMatch(Class<?>) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.ClassAnnotationMatchProcessor
processMatch(String, byte[]) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.FileMatchContentsProcessor: Process a matching file.
processMatch(String, InputStream, int) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.FileMatchProcessor: Process a matching file.
processMatch(Class<? extends T>) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.InterfaceMatchProcessor
processMatch(String, String, Object) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.StaticFinalFieldMatchProcessor
processMatch(Class<? extends T>) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.SubclassMatchProcessor
processMatch(Class<? extends T>) - Method in interface io.github.lukehutch.fastclasspathscanner.matchprocessor.SubinterfaceMatchProcessor
processMatch(String, InputStream, int) - Method in class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner.FilePathMatcher
put(HashMap<K, ArrayList<V>>, K, V) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.MultiMap
put(HashMap<K, HashSet<V>>, K, V) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.MultiSet
putAll(HashMap<K, ArrayList<V>>, K, Iterable<V>) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.MultiMap
putAll(HashMap<K, HashSet<V>>, K, Iterable<V>) - Static method in class io.github.lukehutch.fastclasspathscanner.utils.MultiSet

R

readClassInfoFromClassfileHeader(String, InputStream, ClassInfo, HashMap<String, HashMap<String, StaticFinalFieldMatchProcessor>>) - Static method in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassfileBinaryParser: Directly examine contents of classfile binary header, and write the information obtained into the classInfo out-parameter.
RecursiveScanner - Class in io.github.lukehutch.fastclasspathscanner.scanner
RecursiveScanner(ClasspathFinder, String[], String[]) - Constructor for class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner
RecursiveScanner.FilePathMatcher - Class in io.github.lukehutch.fastclasspathscanner.scanner: A class used for associating a FilePathTester with a FileMatchProcessor.
RecursiveScanner.FilePathTester - Interface in io.github.lukehutch.fastclasspathscanner.scanner: An interface used to test whether a file's relative path matches a given specification.
resolve() - Method in class io.github.lukehutch.fastclasspathscanner.utils.LazyMap

S

scan() - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Scans the classpath for matching files, and calls any match processors if a match is identified.
scan(boolean) - Method in class io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner: Scans the classpath for matching files, and calls any match processors if a match is identified.
scan() - Method in class io.github.lukehutch.fastclasspathscanner.utils.HashClassfileContents: Scans the classpath, and updates the mapping from class name to hash of classfile contents.
StaticFinalFieldMatchProcessor - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when a class with the matching class name and with a final static field with the matching field name is found on the classpath.
SubclassMatchProcessor<T> - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when a subclass of a specific class is found on the classpath.
SubinterfaceMatchProcessor<T> - Interface in io.github.lukehutch.fastclasspathscanner.matchprocessor: The method to run when an interface that extends another specific interface is found on the classpath.
superclassName - Variable in class io.github.lukehutch.fastclasspathscanner.classgraph.ClassInfo

T

toString() - Method in class io.github.lukehutch.fastclasspathscanner.utils.LazyMap

U

Utils - Class in io.github.lukehutch.fastclasspathscanner.utils
Utils() - Constructor for class io.github.lukehutch.fastclasspathscanner.utils.Utils

V

verbose - Static variable in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: If set to true, print info while scanning
verbose() - Method in class io.github.lukehutch.fastclasspathscanner.FastClasspathScanner: Switch on verbose mode (prints debug info to System.out).

A C F G H I L M O P R S T U V