A B C D E F G H I L M N O P R S T U V W 
All Classes All Packages

A

accept(AnnotationInfo) - Method in interface io.github.classgraph.AnnotationInfoList.AnnotationInfoFilter
Whether or not to allow an AnnotationInfo list item through the filter.
accept(ClassInfo) - Method in interface io.github.classgraph.ClassInfoList.ClassInfoFilter
Whether or not to allow a ClassInfo list item through the filter.
accept(FieldInfo) - Method in interface io.github.classgraph.FieldInfoList.FieldInfoFilter
Whether or not to allow an FieldInfo list item through the filter.
accept(MethodInfo) - Method in interface io.github.classgraph.MethodInfoList.MethodInfoFilter
Whether or not to allow an MethodInfo list item through the filter.
accept(ModuleInfo) - Method in interface io.github.classgraph.ModuleInfoList.ModuleInfoFilter
Whether or not to allow an ModuleInfo list item through the filter.
accept(PackageInfo) - Method in interface io.github.classgraph.PackageInfoList.PackageInfoFilter
Whether or not to allow an PackageInfo list item through the filter.
accept(Resource) - Method in interface io.github.classgraph.ResourceList.ResourceFilter
Whether or not to allow a Resource list item through the filter.
accept(Resource, byte[]) - Method in interface io.github.classgraph.ResourceList.ByteArrayConsumer
Consume the complete content of a Resource as a byte array.
accept(Resource, InputStream) - Method in interface io.github.classgraph.ResourceList.InputStreamConsumer
Consume a Resource as an InputStream.
accept(Resource, ByteBuffer) - Method in interface io.github.classgraph.ResourceList.ByteBufferConsumer
Consume a Resource as a ByteBuffer.
addClassLoader(ClassLoader) - Method in class io.github.classgraph.ClassGraph
Add a ClassLoader to the list of ClassLoaders to scan.
addModuleLayer(Object) - Method in class io.github.classgraph.ClassGraph
Add a ModuleLayer to the list of ModuleLayers to scan.
AnnotationClassRef - Class in io.github.classgraph
Stores the type descriptor of a Class<?>, as found in an annotation parameter value.
AnnotationEnumValue - Class in io.github.classgraph
Class for wrapping an enum constant value (split into class name and constant name), as used as an annotation parameter value.
AnnotationInfo - Class in io.github.classgraph
Holds metadata about a specific annotation instance on a class, method, method parameter or field.
AnnotationInfoList - Class in io.github.classgraph
A list of AnnotationInfo objects.
AnnotationInfoList.AnnotationInfoFilter - Interface in io.github.classgraph
Filter an AnnotationInfoList using a predicate mapping an AnnotationInfo object to a boolean, producing another AnnotationInfoList for all items in the list for which the predicate is true.
AnnotationParameterValue - Class in io.github.classgraph
A wrapper used to pair annotation parameter names with annotation parameter values.
AnnotationParameterValueList - Class in io.github.classgraph
A list of AnnotationParameterValue objects.
ANY - io.github.classgraph.TypeArgument.Wildcard
The '?' wildcard
ArrayTypeSignature - Class in io.github.classgraph
An array type signature.
asMap() - Method in class io.github.classgraph.AnnotationParameterValueList
 
asMap() - Method in class io.github.classgraph.MethodInfoList
 
asMap() - Method in class io.github.classgraph.ResourceList
 
available() - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 

B

BaseTypeSignature - Class in io.github.classgraph
A type signature for a base type (byte, char, double, float, int, long, short, boolean, or void).
blacklistClasses(String...) - Method in class io.github.classgraph.ClassGraph
Specifically blacklist one or more specific classes, preventing them from being scanned even if they are in a whitelisted package.
blacklistClasspathElementsContainingResourcePath(String...) - Method in class io.github.classgraph.ClassGraph
Blacklist classpath elements based on resource paths.
blacklistJars(String...) - Method in class io.github.classgraph.ClassGraph
Blacklist one or more jars, preventing them from being scanned.
blacklistLibOrExtJars(String...) - Method in class io.github.classgraph.ClassGraph
Blacklist one or more jars in a JRE/JDK "lib/" or "ext/" directory, preventing them from being scanned.
blacklistModules(String...) - Method in class io.github.classgraph.ClassGraph
Blacklist one or more modules, preventing them from being scanned.
blacklistPackages(String...) - Method in class io.github.classgraph.ClassGraph
Prevent the scanning of one or more specific packages and their sub-packages.
blacklistPaths(String...) - Method in class io.github.classgraph.ClassGraph
Prevent the scanning of one or more specific paths and their sub-directories / nested paths.
byteBuffer - Variable in class io.github.classgraph.Resource
 
byteBufferToByteArray() - Method in class io.github.classgraph.Resource
 
byteBufferToInputStream() - Method in class io.github.classgraph.Resource
 

C

classFilesOnly() - Method in class io.github.classgraph.ResourceList
 
ClassGraph - Class in io.github.classgraph
Uber-fast, ultra-lightweight Java classpath and module path scanner.
ClassGraph() - Constructor for class io.github.classgraph.ClassGraph
Construct a ClassGraph instance.
ClassGraph.ClasspathElementFilter - Interface in io.github.classgraph
Add a classpath element filter.
ClassGraph.FailureHandler - Interface in io.github.classgraph
A callback used to handle failure during an asynchronous scan.
ClassGraph.ScanResultProcessor - Interface in io.github.classgraph
A callback used to process the result of a successful asynchronous scan.
ClassInfo - Class in io.github.classgraph
Holds metadata about a class encountered during a scan.
ClassInfoList - Class in io.github.classgraph
A list of ClassInfo objects, which stores both reachable classes (obtained through a given class relationship, either by direct relationship or through an indirect path), and directly related classes (classes reachable through a direct relationship only).
ClassInfoList.ClassInfoFilter - Interface in io.github.classgraph
Filter a ClassInfoList using a predicate mapping a ClassInfo object to a boolean, producing another ClassInfoList for all items in the list for which the predicate is true.
classpathContentsLastModifiedTime() - Method in class io.github.classgraph.ScanResult
Find the maximum last-modified timestamp of any whitelisted file/directory/jarfile encountered during the scan.
classpathContentsModifiedSinceScan() - Method in class io.github.classgraph.ScanResult
Determine whether the classpath contents have been modified since the last scan.
ClassRefOrTypeVariableSignature - Class in io.github.classgraph
A class type or type variable.
ClassRefOrTypeVariableSignature() - Constructor for class io.github.classgraph.ClassRefOrTypeVariableSignature
 
ClassRefTypeSignature - Class in io.github.classgraph
A class reference type signature (called "ClassTypeSignature" in the classfile documentation).
ClassTypeSignature - Class in io.github.classgraph
A class type signature (called "ClassSignature" in the classfile documentation).
close() - Method in class io.github.classgraph.ModuleReaderProxy
Calls ModuleReader#close().
close() - Method in class io.github.classgraph.Resource
Close the underlying InputStream, or release/unmap the underlying ByteBuffer.
close() - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
Close parent resource, which will call Resource.InputStreamResourceCloser.closeInputStream().
close() - Method in class io.github.classgraph.ResourceList
Close all the Resource objects in this ResourceList.
close() - Method in class io.github.classgraph.ScanResult
Free any temporary files created by extracting jars or files from within jars.
compareTo(AnnotationEnumValue) - Method in class io.github.classgraph.AnnotationEnumValue
 
compareTo(AnnotationInfo) - Method in class io.github.classgraph.AnnotationInfo
 
compareTo(AnnotationParameterValue) - Method in class io.github.classgraph.AnnotationParameterValue
 
compareTo(ClassInfo) - Method in class io.github.classgraph.ClassInfo
Compare based on class name.
compareTo(FieldInfo) - Method in class io.github.classgraph.FieldInfo
Sort in order of class name then field name
compareTo(MethodInfo) - Method in class io.github.classgraph.MethodInfo
Sort in order of class name, method name, then type descriptor.
compareTo(ModuleInfo) - Method in class io.github.classgraph.ModuleInfo
 
compareTo(ModuleRef) - Method in class io.github.classgraph.ModuleRef
 
compareTo(PackageInfo) - Method in class io.github.classgraph.PackageInfo
 
compareTo(Resource) - Method in class io.github.classgraph.Resource
 
containsName(String) - Method in class io.github.classgraph.AnnotationParameterValueList
 
containsName(String) - Method in class io.github.classgraph.MethodInfoList
 

D

directOnly() - Method in class io.github.classgraph.AnnotationInfoList
returns the list of direct annotations, excluding meta-annotations.
directOnly() - Method in class io.github.classgraph.ClassInfoList
Get the list of classes that were directly related, as opposed to reachable through multiple steps.
disableDirScanning() - Method in class io.github.classgraph.ClassGraph
Disables the scanning of directories.
disableJarScanning() - Method in class io.github.classgraph.ClassGraph
Disables the scanning of jarfiles.
disableModuleScanning() - Method in class io.github.classgraph.ClassGraph
Disables the scanning of modules.
disableNestedJarScanning() - Method in class io.github.classgraph.ClassGraph
Disables the scanning of nested jarfiles (jarfiles within jarfiles).
disableRuntimeInvisibleAnnotations() - Method in class io.github.classgraph.ClassGraph
Causes only runtime visible annotations to be scanned (causes runtime invisible annotations to be ignored).

E

enableAllInfo() - Method in class io.github.classgraph.ClassGraph
Enables the scanning of all classes, fields, methods, annotations, and static final field constant initializer values, and ignores all visibility modifiers, so that both public and non-public classes, fields and methods are all scanned.
enableAnnotationInfo() - Method in class io.github.classgraph.ClassGraph
Enables the saving of annotation info (for class, field, method and method parameter annotations) during the scan.
enableClassInfo() - Method in class io.github.classgraph.ClassGraph
Enables the scanning of classfiles, producing ClassInfo objects in the ScanResult.
enableExternalClasses() - Method in class io.github.classgraph.ClassGraph
Causes ClassGraph to return classes that are not in the whitelisted packages, but that are directly referred to by classes within whitelisted packages as a superclass, implemented interface or annotation.
enableFieldInfo() - Method in class io.github.classgraph.ClassGraph
Enables the saving of field info during the scan.
enableInterClassDependencies() - Method in class io.github.classgraph.ClassGraph
Enables the determination of inter-class dependencies, which may be read by calling ClassInfo.getClassDependencies(), ScanResult.getClassDependencyMap() or ScanResult.getReverseClassDependencyMap().
enableMethodInfo() - Method in class io.github.classgraph.ClassGraph
Enables the saving of method info during the scan.
enableRealtimeLogging() - Method in class io.github.classgraph.ClassGraph
Enables logging by calling ClassGraph.verbose(), and then sets the logger to "realtime logging mode", where log entries are written out immediately to stderr, rather than only after the scan has completed.
enableRemoteJarScanning() - Method in class io.github.classgraph.ClassGraph
Enable classpath elements to be fetched from remote http/https URLs to local temporary files and scanned.
enableStaticFinalFieldConstantInitializerValues() - Method in class io.github.classgraph.ClassGraph
Enables the saving of static final field constant initializer values.
enableSystemJarsAndModules() - Method in class io.github.classgraph.ClassGraph
Enables the scanning of system packages ("java.*", "javax.*", "javafx.*", "jdk.*", "oracle.*", "sun.*") -- these are not scanned by default for speed.
enableSystemPackages() - Method in class io.github.classgraph.ClassGraph
Deprecated.
equals(Object) - Method in class io.github.classgraph.AnnotationClassRef
 
equals(Object) - Method in class io.github.classgraph.AnnotationEnumValue
 
equals(Object) - Method in class io.github.classgraph.AnnotationInfo
 
equals(Object) - Method in class io.github.classgraph.AnnotationParameterValue
 
equals(Object) - Method in class io.github.classgraph.ArrayTypeSignature
 
equals(Object) - Method in class io.github.classgraph.BaseTypeSignature
 
equals(Object) - Method in class io.github.classgraph.ClassInfo
Use class name for equals().
equals(Object) - Method in class io.github.classgraph.ClassRefTypeSignature
 
equals(Object) - Method in class io.github.classgraph.ClassTypeSignature
 
equals(Object) - Method in class io.github.classgraph.FieldInfo
Use class name and field name for equals().
equals(Object) - Method in class io.github.classgraph.MethodInfo
Test class name, method name and type descriptor for equals().
equals(Object) - Method in class io.github.classgraph.MethodTypeSignature
 
equals(Object) - Method in class io.github.classgraph.ModuleInfo
 
equals(Object) - Method in class io.github.classgraph.ModuleRef
 
equals(Object) - Method in class io.github.classgraph.PackageInfo
 
equals(Object) - Method in class io.github.classgraph.Resource
 
equals(Object) - Method in class io.github.classgraph.TypeArgument
 
equals(Object) - Method in class io.github.classgraph.TypeParameter
 
equals(Object) - Method in class io.github.classgraph.TypeVariableSignature
 
equalsIgnoringTypeParams(TypeSignature) - Method in class io.github.classgraph.ArrayTypeSignature
 
equalsIgnoringTypeParams(TypeSignature) - Method in class io.github.classgraph.BaseTypeSignature
 
equalsIgnoringTypeParams(TypeSignature) - Method in class io.github.classgraph.ClassRefTypeSignature
 
equalsIgnoringTypeParams(TypeSignature) - Method in class io.github.classgraph.TypeSignature
Compare base types, ignoring generic type parameters.
equalsIgnoringTypeParams(TypeSignature) - Method in class io.github.classgraph.TypeVariableSignature
 
exclude(ClassInfoList) - Method in class io.github.classgraph.ClassInfoList
Find the set difference between this ClassInfoList and another ClassInfoList, i.e.
EXTENDS - io.github.classgraph.TypeArgument.Wildcard
extends
extendsSuperclass(String) - Method in class io.github.classgraph.ClassInfo
 

F

FieldInfo - Class in io.github.classgraph
Holds metadata about fields of a class encountered during a scan.
FieldInfoList - Class in io.github.classgraph
A list of FieldInfo objects.
FieldInfoList.FieldInfoFilter - Interface in io.github.classgraph
Filter an FieldInfoList using a predicate mapping an FieldInfo object to a boolean, producing another FieldInfoList for all items in the list for which the predicate is true.
filter(AnnotationInfoList.AnnotationInfoFilter) - Method in class io.github.classgraph.AnnotationInfoList
Find the subset of the AnnotationInfo objects in this list for which the given filter predicate is true.
filter(ClassInfoList.ClassInfoFilter) - Method in class io.github.classgraph.ClassInfoList
Find the subset of this ClassInfoList for which the given filter predicate is true.
filter(FieldInfoList.FieldInfoFilter) - Method in class io.github.classgraph.FieldInfoList
Find the subset of the FieldInfo objects in this list for which the given filter predicate is true.
filter(MethodInfoList.MethodInfoFilter) - Method in class io.github.classgraph.MethodInfoList
Find the subset of the MethodInfo objects in this list for which the given filter predicate is true.
filter(ModuleInfoList.ModuleInfoFilter) - Method in class io.github.classgraph.ModuleInfoList
Find the subset of the ModuleInfo objects in this list for which the given filter predicate is true.
filter(PackageInfoList.PackageInfoFilter) - Method in class io.github.classgraph.PackageInfoList
Find the subset of the PackageInfo objects in this list for which the given filter predicate is true.
filter(ResourceList.ResourceFilter) - Method in class io.github.classgraph.ResourceList
Find the subset of the Resource objects in this list for which the given filter predicate is true.
filterClasspathElements(ClassGraph.ClasspathElementFilter) - Method in class io.github.classgraph.ClassGraph
Add a classpath element filter.
findDuplicatePaths() - Method in class io.github.classgraph.ResourceList
 
forEachByteArray(ResourceList.ByteArrayConsumer) - Method in class io.github.classgraph.ResourceList
Fetch the content of each Resource in this ResourceList as a byte array, pass the byte array to the given ResourceList.ByteArrayConsumer, then close the underlying InputStream or release the underlying ByteBuffer by calling Resource.close().
forEachByteArray(ResourceList.ByteArrayConsumer, boolean) - Method in class io.github.classgraph.ResourceList
Fetch the content of each Resource in this ResourceList as a byte array, pass the byte array to the given ResourceList.ByteArrayConsumer, then close the underlying InputStream or release the underlying ByteBuffer by calling Resource.close().
forEachByteBuffer(ResourceList.ByteBufferConsumer) - Method in class io.github.classgraph.ResourceList
Read each Resource in this ResourceList as a ByteBuffer, pass the ByteBuffer to the given ResourceList.InputStreamConsumer, then release the ByteBuffer after the ResourceList.ByteBufferConsumer returns, by calling Resource.close().
forEachByteBuffer(ResourceList.ByteBufferConsumer, boolean) - Method in class io.github.classgraph.ResourceList
Read each Resource in this ResourceList as a ByteBuffer, pass the ByteBuffer to the given ResourceList.InputStreamConsumer, then release the ByteBuffer after the ResourceList.ByteBufferConsumer returns, by calling Resource.close().
forEachInputStream(ResourceList.InputStreamConsumer) - Method in class io.github.classgraph.ResourceList
Fetch an InputStream for each Resource in this ResourceList, pass the InputStream to the given ResourceList.InputStreamConsumer, then close the InputStream after the ResourceList.InputStreamConsumer returns, by calling Resource.close().
forEachInputStream(ResourceList.InputStreamConsumer, boolean) - Method in class io.github.classgraph.ResourceList
Fetch an InputStream for each Resource in this ResourceList, pass the InputStream to the given ResourceList.InputStreamConsumer, then close the InputStream after the ResourceList.InputStreamConsumer returns, by calling Resource.close().
fromJSON(String) - Static method in class io.github.classgraph.ScanResult
Deserialize a ScanResult from previously-serialized JSON.

G

generateGraphVizDotFile() - Method in class io.github.classgraph.ClassInfoList
Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
generateGraphVizDotFile(float, float) - Method in class io.github.classgraph.ClassInfoList
Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
generateGraphVizDotFile(float, float, boolean, boolean, boolean, boolean, boolean) - Method in class io.github.classgraph.ClassInfoList
Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
generateGraphVizDotFile(File) - Method in class io.github.classgraph.ClassInfoList
Generate a and save a .dot file, which can be fed into GraphViz for layout and visualization of the class graph.
generateGraphVizDotFileFromClassDependencies() - Method in class io.github.classgraph.ClassInfoList
Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
generateGraphVizDotFileFromInterClassDependencies(float, float, boolean) - Method in class io.github.classgraph.ClassInfoList
Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
get(String) - Method in class io.github.classgraph.AnnotationParameterValueList
 
get(String) - Method in class io.github.classgraph.MethodInfoList
Returns a list of all methods matching a given name.
getAllAnnotations() - Method in class io.github.classgraph.ScanResult
Get all annotation classes found during the scan.
getAllClasses() - Method in class io.github.classgraph.ScanResult
Get all classes, interfaces and annotations found during the scan.
getAllInterfaces() - Method in class io.github.classgraph.ScanResult
Get all interface classes found during the scan (not including annotations, which are also technically interfaces).
getAllInterfacesAndAnnotations() - Method in class io.github.classgraph.ScanResult
Get all interface or annotation classes found during the scan.
getAllResources() - Method in class io.github.classgraph.ScanResult
 
getAllStandardClasses() - Method in class io.github.classgraph.ScanResult
Get all standard (non-interface/non-annotation) classes found during the scan.
getAnnotationDefaultParameterValues() - Method in class io.github.classgraph.ClassInfo
 
getAnnotationInfo() - Method in class io.github.classgraph.ClassInfo
Get a list of the annotations on this class, or the empty list if none.
getAnnotationInfo() - Method in class io.github.classgraph.FieldInfo
Get a list of annotations on this field, along with any annotation parameter values, wrapped in AnnotationInfo objects.
getAnnotationInfo() - Method in class io.github.classgraph.MethodInfo
Get a list of annotations on this method, along with any annotation parameter values.
getAnnotationInfo() - Method in class io.github.classgraph.MethodParameterInfo
Method parameter annotation info (or null if no annotations).
getAnnotationInfo() - Method in class io.github.classgraph.ModuleInfo
Get any annotations on the package-info.class file.
getAnnotationInfo() - Method in class io.github.classgraph.PackageInfo
Get any annotations on the package-info.class file.
getAnnotationInfo(String) - Method in class io.github.classgraph.ClassInfo
Get a the named annotation on this class, or null if the class does not have the named annotation.
getAnnotationInfo(String) - Method in class io.github.classgraph.FieldInfo
Get a the named annotation on this field, or null if the field does not have the named annotation.
getAnnotationInfo(String) - Method in class io.github.classgraph.MethodInfo
Get a the named annotation on this method, or null if the method does not have the named annotation.
getAnnotationInfo(String) - Method in class io.github.classgraph.MethodParameterInfo
Get a the named annotation on this method parameter, or null if the method parameter does not have the named annotation.
getAnnotationInfo(String) - Method in class io.github.classgraph.ModuleInfo
Get a the named annotation on this module, or null if the module does not have the named annotation.
getAnnotationInfo(String) - Method in class io.github.classgraph.PackageInfo
Get a the named annotation on this package, or null if the package does not have the named annotation.
getAnnotations() - Method in class io.github.classgraph.ClassInfo
Get the annotations and meta-annotations on this class.
getAnnotations() - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only annotations.
getAnnotationsOnClass(String) - Method in class io.github.classgraph.ScanResult
Get annotations on the named class.
getAssignableTo(ClassInfo) - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only classes that are assignable to the requested class, assignableToClass (i.e.
getAsStrings() - Method in class io.github.classgraph.AnnotationParameterValueList
 
getBaseClassName() - Method in class io.github.classgraph.ClassRefTypeSignature
Get the name of the base class.
getChildren() - Method in class io.github.classgraph.PackageInfo
The child packages of this package, or the empty list if none.
getClassBound() - Method in class io.github.classgraph.TypeParameter
Get the type parameter class bound.
getClassDependencies() - Method in class io.github.classgraph.ClassInfo
 
getClassDependencyMap() - Method in class io.github.classgraph.ScanResult
 
getClassesImplementing() - Method in class io.github.classgraph.ClassInfo
 
getClassesImplementing(String) - Method in class io.github.classgraph.ScanResult
Get all classes that implement (or have superclasses that implement) the named interface (or one of its subinterfaces).
getClassesWithAnnotation() - Method in class io.github.classgraph.ClassInfo
 
getClassesWithAnnotation(String) - Method in class io.github.classgraph.ScanResult
Get classes with the named class annotation or meta-annotation.
getClassesWithFieldAnnotation() - Method in class io.github.classgraph.ClassInfo
 
getClassesWithFieldAnnotation(String) - Method in class io.github.classgraph.ScanResult
Get classes that have a field with an annotation of the named type.
getClassesWithMethodAnnotation() - Method in class io.github.classgraph.ClassInfo
 
getClassesWithMethodAnnotation(String) - Method in class io.github.classgraph.ScanResult
Get classes that have a method with an annotation of the named type.
getClassInfo() - Method in class io.github.classgraph.AnnotationClassRef
 
getClassInfo() - Method in class io.github.classgraph.AnnotationInfo
 
getClassInfo() - Method in class io.github.classgraph.AnnotationParameterValue
 
getClassInfo() - Method in class io.github.classgraph.ArrayTypeSignature
 
getClassInfo() - Method in class io.github.classgraph.BaseTypeSignature
 
getClassInfo() - Method in class io.github.classgraph.ClassInfo
 
getClassInfo() - Method in class io.github.classgraph.ClassRefTypeSignature
 
getClassInfo() - Method in class io.github.classgraph.ClassTypeSignature
 
getClassInfo() - Method in class io.github.classgraph.FieldInfo
 
getClassInfo() - Method in class io.github.classgraph.MethodInfo
 
getClassInfo() - Method in class io.github.classgraph.MethodTypeSignature
 
getClassInfo() - Method in class io.github.classgraph.ModuleInfo
Get the ClassInfo objects for all classes that are members of this package.
getClassInfo() - Method in class io.github.classgraph.PackageInfo
Get the ClassInfo objects for all classes that are members of this package.
getClassInfo() - Method in class io.github.classgraph.TypeArgument
 
getClassInfo() - Method in class io.github.classgraph.TypeParameter
 
getClassInfo(String) - Method in class io.github.classgraph.ModuleInfo
Get the ClassInfo object for the named class in this module, or null if the class was not found in this module.
getClassInfo(String) - Method in class io.github.classgraph.PackageInfo
Get the ClassInfo object for the named class in this package, or null if the class was not found in this module.
getClassInfo(String) - Method in class io.github.classgraph.ScanResult
Get the ClassInfo object for the named class, or null if no class of the requested name was found in a whitelisted/non-blacklisted package during the scan.
getClassInfoRecursive() - Method in class io.github.classgraph.PackageInfo
Get the ClassInfo objects for all classes that are members of this package or a sub-package.
getClassLoader() - Method in class io.github.classgraph.ModuleRef
 
getClassName() - Method in class io.github.classgraph.AnnotationClassRef
 
getClassName() - Method in class io.github.classgraph.AnnotationEnumValue
 
getClassName() - Method in class io.github.classgraph.AnnotationInfo
Return the name of the annotation class, for AnnotationInfo.getClassInfo().
getClassName() - Method in class io.github.classgraph.AnnotationParameterValue
 
getClassName() - Method in class io.github.classgraph.ArrayTypeSignature
 
getClassName() - Method in class io.github.classgraph.BaseTypeSignature
 
getClassName() - Method in class io.github.classgraph.ClassInfo
 
getClassName() - Method in class io.github.classgraph.ClassRefTypeSignature
Get the fully qualified class name (used by ClassRefTypeSignature.getClassInfo() and ClassRefTypeSignature.loadClass().
getClassName() - Method in class io.github.classgraph.ClassTypeSignature
 
getClassName() - Method in class io.github.classgraph.FieldInfo
Returns the name of the declaring class, so that super.getClassInfo() returns the ClassInfo object for the declaring class.
getClassName() - Method in class io.github.classgraph.MethodInfo
Returns the declaring class name, so that super.getClassInfo() returns the ClassInfo object for the declaring class.
getClassName() - Method in class io.github.classgraph.MethodTypeSignature
 
getClassName() - Method in class io.github.classgraph.TypeArgument
 
getClassName() - Method in class io.github.classgraph.TypeParameter
 
getClassName() - Method in class io.github.classgraph.TypeVariableSignature
Return definingClassName, so that getClassInfo() returns the ClassInfo object for the containing class.
getClasspath() - Method in class io.github.classgraph.ClassGraph
Returns the list of all unique File objects representing directories or zip/jarfiles on the classpath, in classloader resolution order, in the form of a classpath path string.
getClasspath() - Method in class io.github.classgraph.ScanResult
Returns all unique directories or zip/jarfiles on the classpath, in classloader resolution order, as a classpath string, delineated with the standard path separator character.
getClasspathElementFile() - Method in class io.github.classgraph.ClassInfo
 
getClasspathElementFile() - Method in class io.github.classgraph.Resource
 
getClasspathElementURL() - Method in class io.github.classgraph.ClassInfo
 
getClasspathElementURL() - Method in class io.github.classgraph.Resource
 
getClasspathFiles() - Method in class io.github.classgraph.ClassGraph
Returns the list of all unique File objects representing directories or zip/jarfiles on the classpath, in classloader resolution order.
getClasspathFiles() - Method in class io.github.classgraph.ScanResult
Returns the list of File objects for unique classpath elements (directories or jarfiles), in classloader resolution order.
getClasspathURLs() - Method in class io.github.classgraph.ClassGraph
Returns the list of all unique URL objects representing directories, zip/jarfiles or modules on the classpath, in classloader resolution order.
getClasspathURLs() - Method in class io.github.classgraph.ScanResult
Returns the list of unique classpath element paths as URLs, in classloader resolution order.
getConstantInitializerValue() - Method in class io.github.classgraph.FieldInfo
Returns the constant initializer value of a constant final field.
getConstructorInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on visible constructors declared by this class, or by its interfaces or superclasses.
getDeclaredConstructorInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on visible constructors declared by this class, but not by its interfaces or superclasses.
getDeclaredFieldInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on all visible fields declared by this class, but not by its superclasses.
getDeclaredFieldInfo(String) - Method in class io.github.classgraph.ClassInfo
Returns information on the named field declared by the class, but not by its superclasses.
getDeclaredMethodAndConstructorInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on visible methods and constructors declared by this class, but not by its interfaces or superclasses.
getDeclaredMethodInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on visible methods declared by this class, but not by its interfaces or superclasses, that are not constructors.
getDeclaredMethodInfo(String) - Method in class io.github.classgraph.ClassInfo
Returns information on the method(s) or constructor(s) of the given name declared by this class, but not by its interfaces or superclasses.
getDefaultParameterValues() - Method in class io.github.classgraph.AnnotationInfo
 
getDescriptor() - Method in class io.github.classgraph.ModuleRef
 
getElementTypeSignature() - Method in class io.github.classgraph.ArrayTypeSignature
 
getEnums() - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only Enum classes.
getFieldAnnotations() - Method in class io.github.classgraph.ClassInfo
 
getFieldInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on all visible fields declared by this class, or by its superclasses.
getFieldInfo(String) - Method in class io.github.classgraph.ClassInfo
Returns information on the named filed declared by this class, or by its superclasses.
getFullyQualifiedClassName() - Method in class io.github.classgraph.ClassRefTypeSignature
Get the name of the class, formed from the base name and any suffixes (suffixes are for inner class nesting, and are separated by '$'), but without any type arguments.
getFullyQualifiedDefiningMethodName() - Method in class io.github.classgraph.ClassInfo
 
getImplementedInterfaces() - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only implemented interfaces, i.e.
getInnerClasses() - Method in class io.github.classgraph.ClassInfo
 
getInterfaceBounds() - Method in class io.github.classgraph.TypeParameter
Get the type parameter interface bound(s).
getInterfaces() - Method in class io.github.classgraph.ClassInfo
 
getInterfaces() - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only interfaces that are not annotations.
getInterfaces(String) - Method in class io.github.classgraph.ScanResult
Get all interfaces implemented by the named class or by one of its superclasses, if this is a standard class, or the superinterfaces extended by this interface, if this is an interface.
getInterfacesAndAnnotations() - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only interfaces and annotations (annotations are interfaces, and can be implemented).
getLayer() - Method in class io.github.classgraph.ModuleRef
 
getLength() - Method in class io.github.classgraph.Resource
 
getLocation() - Method in class io.github.classgraph.ModuleInfo
The module location.
getLocation() - Method in class io.github.classgraph.ModuleRef
 
getLocationFile() - Method in class io.github.classgraph.ModuleRef
 
getLocationStr() - Method in class io.github.classgraph.ModuleRef
 
getMethodAndConstructorInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on visible constructors declared by this class, or by its interfaces or superclasses.
getMethodAnnotations() - Method in class io.github.classgraph.ClassInfo
 
getMethodInfo() - Method in class io.github.classgraph.ClassInfo
Returns information on visible methods declared by this class, or by its interfaces or superclasses, that are not constructors.
getMethodInfo() - Method in class io.github.classgraph.MethodParameterInfo
 
getMethodInfo(String) - Method in class io.github.classgraph.ClassInfo
Returns information on the method(s) or constructor(s) of the given name declared by this class, but not by its interfaces or superclasses.
getModifiers() - Method in class io.github.classgraph.ClassInfo
 
getModifiers() - Method in class io.github.classgraph.FieldInfo
Returns the modifier bits for the field.
getModifiers() - Method in class io.github.classgraph.MethodInfo
Returns the modifier bits for the method.
getModifiers() - Method in class io.github.classgraph.MethodParameterInfo
Method parameter modifiers.
getModifiersStr() - Method in class io.github.classgraph.ClassInfo
 
getModifiersStr() - Method in class io.github.classgraph.MethodInfo
Get the method modifiers as a String, e.g.
getModifiersStr() - Method in class io.github.classgraph.MethodParameterInfo
Get the method parameter modifiers as a String, e.g.
getModifierStr() - Method in class io.github.classgraph.FieldInfo
Get the field modifiers as a string, e.g.
getModuleInfo() - Method in class io.github.classgraph.ScanResult
Get all modules found during the scan.
getModuleInfo(String) - Method in class io.github.classgraph.ScanResult
Get the ModuleInfo object for the named module, or null if no module of the requested name was found during the scan.
getModuleRef() - Method in class io.github.classgraph.ClassInfo
 
getModuleRef() - Method in class io.github.classgraph.ModuleInfo
The ModuleRef for this module.
getModuleRef() - Method in class io.github.classgraph.Resource
 
getModules() - Method in class io.github.classgraph.ClassGraph
Returns ModuleRef references for all the visible modules.
getModules() - Method in class io.github.classgraph.ScanResult
 
getName() - Method in class io.github.classgraph.AnnotationClassRef
 
getName() - Method in class io.github.classgraph.AnnotationEnumValue
 
getName() - Method in class io.github.classgraph.AnnotationInfo
 
getName() - Method in class io.github.classgraph.AnnotationParameterValue
 
getName() - Method in class io.github.classgraph.ClassInfo
 
getName() - Method in class io.github.classgraph.FieldInfo
 
getName() - Method in class io.github.classgraph.MethodInfo
Returns the name of the method.
getName() - Method in class io.github.classgraph.MethodParameterInfo
Method parameter name.
getName() - Method in class io.github.classgraph.ModuleInfo
The module name ("<unnamed>" for the unnamed module).
getName() - Method in class io.github.classgraph.ModuleRef
 
getName() - Method in class io.github.classgraph.PackageInfo
The package name ("" for the root package).
getName() - Method in class io.github.classgraph.TypeParameter
Get the type parameter identifier.
getName() - Method in class io.github.classgraph.TypeVariableSignature
Get the name of the type variable.
getNames() - Method in class io.github.classgraph.AnnotationParameterValueList
 
getNumDimensions() - Method in class io.github.classgraph.ArrayTypeSignature
 
getOuterClasses() - Method in class io.github.classgraph.ClassInfo
 
getPackageInfo() - Method in class io.github.classgraph.ModuleInfo
Get the PackageInfo objects for all packages that are members of this module.
getPackageInfo() - Method in class io.github.classgraph.ScanResult
Get all packages found during the scan.
getPackageInfo(String) - Method in class io.github.classgraph.ModuleInfo
Get the PackageInfo object for the named packagein this module, or null if the package was not found in this module.
getPackageInfo(String) - Method in class io.github.classgraph.ScanResult
Get the PackageInfo object for the named package, or null if no package of the requested name was found during the scan.
getPackageName() - Method in class io.github.classgraph.ClassInfo
 
getPackages() - Method in class io.github.classgraph.ModuleRef
 
getParameterInfo() - Method in class io.github.classgraph.MethodInfo
Get the available information on method parameters.
getParameterValues() - Method in class io.github.classgraph.AnnotationInfo
 
getParent() - Method in class io.github.classgraph.PackageInfo
The parent package of this package, or null if this is the root package.
getPath() - Method in class io.github.classgraph.Resource
 
getPathRelativeToClasspathElement() - Method in class io.github.classgraph.Resource
 
getPaths() - Method in class io.github.classgraph.ResourceList
 
getPathsRelativeToClasspathElement() - Method in class io.github.classgraph.ResourceList
 
getRawVersion() - Method in class io.github.classgraph.ModuleRef
Get the raw version string of the module, or null if the module did not provide one.
getReference() - Method in class io.github.classgraph.ModuleRef
 
getReferencedClassNames(Set<String>) - Method in class io.github.classgraph.AnnotationClassRef
 
getReferencedClassNames(Set<String>) - Method in class io.github.classgraph.ClassInfo
Get the names of any classes referenced in this class' type descriptor, or the type descriptors of fields, methods or annotations.
getReferencedClassNames(Set<String>) - Method in class io.github.classgraph.FieldInfo
Get the names of any classes in the type descriptor or type signature.
getReferencedClassNames(Set<String>) - Method in class io.github.classgraph.MethodInfo
Get the names of any classes in the type descriptor or type signature.
getResource() - Method in class io.github.classgraph.ClassInfo
 
getResourcesMatchingPattern(Pattern) - Method in class io.github.classgraph.ScanResult
 
getResourcesWithExtension(String) - Method in class io.github.classgraph.ScanResult
 
getResourcesWithLeafName(String) - Method in class io.github.classgraph.ScanResult
 
getResourcesWithPath(String) - Method in class io.github.classgraph.ScanResult
 
getResourcesWithPathIgnoringWhitelist(String) - Method in class io.github.classgraph.ScanResult
 
getResultType() - Method in class io.github.classgraph.MethodTypeSignature
Get the result type for the method.
getReverseClassDependencyMap() - Method in class io.github.classgraph.ScanResult
 
getSimpleName() - Method in class io.github.classgraph.ClassInfo
 
getSingleMethod(String) - Method in class io.github.classgraph.MethodInfoList
Returns a single method with the given name, or null if not found.
getStandardClasses() - Method in class io.github.classgraph.ClassInfoList
Filter this ClassInfoList to include only standard classes (classes that are not interfaces or annotations).
getSubclasses() - Method in class io.github.classgraph.ClassInfo
Get the subclasses of this class, sorted in order of name.
getSubclasses(String) - Method in class io.github.classgraph.ScanResult
Get all subclasses of the named superclass.
getSuffixes() - Method in class io.github.classgraph.ClassRefTypeSignature
Get any suffixes of the class (typically nested inner class names).
getSuffixTypeArguments() - Method in class io.github.classgraph.ClassRefTypeSignature
Get any type arguments for any suffixes of the class, one list per suffix.
getSuperclass() - Method in class io.github.classgraph.ClassInfo
Get the single direct superclass of this class, or null if none.
getSuperclasses() - Method in class io.github.classgraph.ClassInfo
Get all superclasses of this class, in ascending order in the class hierarchy.
getSuperclasses(String) - Method in class io.github.classgraph.ScanResult
Get superclasses of the named subclass.
getSuperclassSignature() - Method in class io.github.classgraph.ClassTypeSignature
Get the type signature for the superclass (possibly null in the case of Object, since it doesn't have a superclass).
getSuperinterfaceSignatures() - Method in class io.github.classgraph.ClassTypeSignature
Get the type signatures of any superinterfaces
getThrowsSignatures() - Method in class io.github.classgraph.MethodTypeSignature
Get the throws type(s) for the method.
getType() - Method in class io.github.classgraph.BaseTypeSignature
 
getTypeArguments() - Method in class io.github.classgraph.ClassRefTypeSignature
Get any type arguments of the base class.
getTypeDescriptor() - Method in class io.github.classgraph.FieldInfo
Returns the parsed type descriptor for the field, if available.
getTypeDescriptor() - Method in class io.github.classgraph.MethodInfo
Returns the parsed type descriptor for the method, which will not include type parameters.
getTypeDescriptor() - Method in class io.github.classgraph.MethodParameterInfo
Method parameter type descriptor.
getTypeParameters() - Method in class io.github.classgraph.ClassTypeSignature
 
getTypeSignature() - Method in class io.github.classgraph.ClassInfo
 
getTypeSignature() - Method in class io.github.classgraph.FieldInfo
Returns the parsed type signature for the field, if available.
getTypeSignature() - Method in class io.github.classgraph.MethodInfo
Returns the parsed type signature for the method, possibly including type parameters.
getTypeSignature() - Method in class io.github.classgraph.MethodParameterInfo
Method parameter type signature, possibly including generic type information (or null if no type signature information available for this parameter).
getTypeSignature() - Method in class io.github.classgraph.TypeArgument
Get the type signature associated with the wildcard (or null, if the wildcard is ANY).
getTypeSignatureOrTypeDescriptor() - Method in class io.github.classgraph.FieldInfo
Returns the type signature for the field, possibly including type parameters.
getTypeSignatureOrTypeDescriptor() - Method in class io.github.classgraph.MethodInfo
Returns the parsed type signature for the method, possibly including type parameters.
getTypeSignatureOrTypeDescriptor() - Method in class io.github.classgraph.MethodParameterInfo
Method parameter type signature, or if not available, method type descriptor.
getTypeStr() - Method in class io.github.classgraph.BaseTypeSignature
 
getURL() - Method in class io.github.classgraph.Resource
 
getURLs() - Method in class io.github.classgraph.ResourceList
 
getValue() - Method in class io.github.classgraph.AnnotationParameterValue
 
getValueName() - Method in class io.github.classgraph.AnnotationEnumValue
 
getVersion() - Static method in class io.github.classgraph.ClassGraph
Get the version number of ClassGraph.
getWildcard() - Method in class io.github.classgraph.TypeArgument
Get the type wildcard, which is one of {NONE, ANY, EXTENDS, SUPER}.

H

hasAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hasAnnotation(String) - Method in class io.github.classgraph.FieldInfo
 
hasAnnotation(String) - Method in class io.github.classgraph.MethodInfo
 
hasAnnotation(String) - Method in class io.github.classgraph.MethodParameterInfo
 
hasAnnotation(String) - Method in class io.github.classgraph.ModuleInfo
 
hasAnnotation(String) - Method in class io.github.classgraph.PackageInfo
 
hasBody() - Method in class io.github.classgraph.MethodInfo
Returns true if this method has a body (i.e.
hasDeclaredField(String) - Method in class io.github.classgraph.ClassInfo
 
hasDeclaredFieldAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hasDeclaredMethod(String) - Method in class io.github.classgraph.ClassInfo
 
hasDeclaredMethodAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hasDeclaredMethodParameterAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hasField(String) - Method in class io.github.classgraph.ClassInfo
 
hasFieldAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hashCode() - Method in class io.github.classgraph.AnnotationClassRef
 
hashCode() - Method in class io.github.classgraph.AnnotationEnumValue
 
hashCode() - Method in class io.github.classgraph.AnnotationInfo
 
hashCode() - Method in class io.github.classgraph.AnnotationParameterValue
 
hashCode() - Method in class io.github.classgraph.ArrayTypeSignature
 
hashCode() - Method in class io.github.classgraph.BaseTypeSignature
 
hashCode() - Method in class io.github.classgraph.ClassInfo
Use hash code of class name.
hashCode() - Method in class io.github.classgraph.ClassRefTypeSignature
 
hashCode() - Method in class io.github.classgraph.ClassTypeSignature
 
hashCode() - Method in class io.github.classgraph.FieldInfo
Use hash code of class name and field name.
hashCode() - Method in class io.github.classgraph.MethodInfo
Use hash code of class name, method name and type descriptor.
hashCode() - Method in class io.github.classgraph.MethodTypeSignature
 
hashCode() - Method in class io.github.classgraph.ModuleInfo
 
hashCode() - Method in class io.github.classgraph.ModuleRef
 
hashCode() - Method in class io.github.classgraph.PackageInfo
 
hashCode() - Method in class io.github.classgraph.Resource
 
hashCode() - Method in class io.github.classgraph.TypeArgument
 
hashCode() - Method in class io.github.classgraph.TypeParameter
 
hashCode() - Method in class io.github.classgraph.TypeVariableSignature
 
hasMethod(String) - Method in class io.github.classgraph.ClassInfo
 
hasMethodAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hasMethodParameterAnnotation(String) - Method in class io.github.classgraph.ClassInfo
 
hasParameterAnnotation(String) - Method in class io.github.classgraph.MethodInfo
 
HierarchicalTypeSignature - Class in io.github.classgraph
A Java type signature.
HierarchicalTypeSignature() - Constructor for class io.github.classgraph.HierarchicalTypeSignature
 

I

ignoreClassVisibility() - Method in class io.github.classgraph.ClassGraph
Causes class visibility to be ignored, enabling private, package-private and protected classes to be scanned.
ignoreFieldVisibility() - Method in class io.github.classgraph.ClassGraph
Causes field visibility to be ignored, enabling private, package-private and protected fields to be scanned.
ignoreMethodVisibility() - Method in class io.github.classgraph.ClassGraph
Causes method visibility to be ignored, enabling private, package-private and protected methods to be scanned.
ignoreParentClassLoaders() - Method in class io.github.classgraph.ClassGraph
Ignore parent classloaders (i.e.
ignoreParentModuleLayers() - Method in class io.github.classgraph.ClassGraph
Ignore parent module layers (i.e.
implementsInterface(String) - Method in class io.github.classgraph.ClassInfo
 
includeClasspathElement(String) - Method in interface io.github.classgraph.ClassGraph.ClasspathElementFilter
 
initializeLoadedClasses() - Method in class io.github.classgraph.ClassGraph
Causes classes loaded using ClassInfo.loadClass() to be are initialized after class loading (the default is to not initialize classes).
inputStream - Variable in class io.github.classgraph.Resource
 
InputStreamResourceCloser(Resource, InputStream) - Constructor for class io.github.classgraph.Resource.InputStreamResourceCloser
 
inputStreamToByteArray() - Method in class io.github.classgraph.Resource
 
inputStreamToByteBuffer() - Method in class io.github.classgraph.Resource
 
intersect(ClassInfoList...) - Method in class io.github.classgraph.ClassInfoList
Find the intersection of this ClassInfoList with one or more others.
io.github.classgraph - package io.github.classgraph
 
isAbstract() - Method in class io.github.classgraph.ClassInfo
 
isAnnotation() - Method in class io.github.classgraph.ClassInfo
 
isAnonymousInnerClass() - Method in class io.github.classgraph.ClassInfo
 
isBridge() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is a bridge method.
isConstructor() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is a constructor.
isDefault() - Method in class io.github.classgraph.MethodInfo
Returns true if this is a default method (i.e.
isEnum() - Method in class io.github.classgraph.ClassInfo
 
isExternalClass() - Method in class io.github.classgraph.ClassInfo
 
isFinal() - Method in class io.github.classgraph.ClassInfo
 
isFinal() - Method in class io.github.classgraph.FieldInfo
Returns true if this field is final.
isFinal() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is final.
isImplementedInterface() - Method in class io.github.classgraph.ClassInfo
Return whether this class is an implemented interface (meaning a standard, non-annotation interface, or an annotation that has also been implemented as an interface by some class).
isInherited() - Method in class io.github.classgraph.AnnotationInfo
 
isInnerClass() - Method in class io.github.classgraph.ClassInfo
 
isInterface() - Method in class io.github.classgraph.ClassInfo
 
isInterfaceOrAnnotation() - Method in class io.github.classgraph.ClassInfo
 
isNative() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is a native method.
isOpen - Variable in class io.github.classgraph.Resource
 
isOuterClass() - Method in class io.github.classgraph.ClassInfo
 
isPublic() - Method in class io.github.classgraph.ClassInfo
 
isPublic() - Method in class io.github.classgraph.FieldInfo
Returns true if this field is public.
isPublic() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is public.
isStandardClass() - Method in class io.github.classgraph.ClassInfo
 
isStatic() - Method in class io.github.classgraph.ClassInfo
 
isStatic() - Method in class io.github.classgraph.FieldInfo
Returns true if this field is static.
isStatic() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is static.
isSynchronized() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is synchronized.
isSynthetic() - Method in class io.github.classgraph.ClassInfo
 
isSystemModule() - Method in class io.github.classgraph.ModuleRef
 
isTransient() - Method in class io.github.classgraph.FieldInfo
Returns true if this field is a transient field.
isVarArgs() - Method in class io.github.classgraph.MethodInfo
Returns true if this method is a varargs method.

L

length - Variable in class io.github.classgraph.Resource
 
list() - Method in class io.github.classgraph.ModuleReaderProxy
Get the list of resources accessible to a ModuleReader.
load() - Method in class io.github.classgraph.Resource
Load a classpath resource and return its content as a byte array.
loadClass() - Method in class io.github.classgraph.AnnotationClassRef
Loads the referenced class, returning a Class<?> reference for the referenced class.
loadClass() - Method in class io.github.classgraph.ClassInfo
Obtain a Class<?> reference for the class named by this ClassInfo object.
loadClass() - Method in class io.github.classgraph.ClassRefTypeSignature
Load the referenced class, if not already loaded, returning a Class<?> reference for the referenced class.
loadClass(boolean) - Method in class io.github.classgraph.AnnotationClassRef
Loads the referenced class, returning a Class<?> reference for the referenced class.
loadClass(boolean) - Method in class io.github.classgraph.ClassInfo
Obtain a Class<?> reference for the class named by this ClassInfo object.
loadClass(boolean) - Method in class io.github.classgraph.ClassRefTypeSignature
Load the referenced class, if not already loaded, returning a Class<?> reference for the referenced class.
loadClass(Class<T>) - Method in class io.github.classgraph.ClassInfo
Obtain a Class<?> reference for the class named by this ClassInfo object, casting it to the requested interface or superclass type.
loadClass(Class<T>, boolean) - Method in class io.github.classgraph.ClassInfo
Obtain a Class<?> reference for the class named by this ClassInfo object, casting it to the requested interface or superclass type.
loadClass(String, boolean) - Method in class io.github.classgraph.ScanResult
Load a class given a class name.
loadClass(String, Class<T>, boolean) - Method in class io.github.classgraph.ScanResult
Load a class given a class name.
loadClassAndGetField() - Method in class io.github.classgraph.FieldInfo
Load the class this field is associated with, and get the Field reference for this field.
loadClassAndGetMethod() - Method in class io.github.classgraph.MethodInfo
Load the class this method is associated with, and get the Method reference for this method.
loadClassAndInstantiate() - Method in class io.github.classgraph.AnnotationInfo
Load the Annotation class corresponding to this AnnotationInfo object, by calling getClassInfo().loadClass(), then create a new instance of the annotation, with the annotation parameter values obtained from this AnnotationInfo object.
loadClassAndReturnEnumValue() - Method in class io.github.classgraph.AnnotationEnumValue
Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this AnnotationEnumValue.
loadClassAndReturnEnumValue(boolean) - Method in class io.github.classgraph.AnnotationEnumValue
Loads the enum class, instantiates the enum constants for the class, and returns the enum constant value represented by this AnnotationEnumValue.
loadClasses() - Method in class io.github.classgraph.ClassInfoList
Convert this list of ClassInfo objects to a list of Class<?> objects.
loadClasses(boolean) - Method in class io.github.classgraph.ClassInfoList
Convert this list of ClassInfo objects to a list of Class<?> objects.
loadClasses(Class<T>) - Method in class io.github.classgraph.ClassInfoList
Convert this list of ClassInfo objects to a list of Class<?> objects, casting each item in the list to the requested superclass or interface type.
loadClasses(Class<T>, boolean) - Method in class io.github.classgraph.ClassInfoList
Convert this list of ClassInfo objects to a list of Class<?> objects, casting each item in the list to the requested superclass or interface type.

M

mark(int) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
markAsClosed() - Method in class io.github.classgraph.Resource
Mark the resource as closed.
markAsOpen() - Method in class io.github.classgraph.Resource
Mark the resource as open.
markSupported() - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
MethodInfo - Class in io.github.classgraph
Holds metadata about methods of a class encountered during a scan.
MethodInfoList - Class in io.github.classgraph
A list of MethodInfo objects.
MethodInfoList.MethodInfoFilter - Interface in io.github.classgraph
Filter an MethodInfoList using a predicate mapping an MethodInfo object to a boolean, producing another MethodInfoList for all items in the list for which the predicate is true.
MethodParameterInfo - Class in io.github.classgraph
Information on the parameters of a method.
MethodTypeSignature - Class in io.github.classgraph
A method type signature (called "MethodSignature" in the classfile documentation).
ModuleInfo - Class in io.github.classgraph
Holds metadata about a package encountered during a scan.
ModuleInfoList - Class in io.github.classgraph
A list of ModuleInfo objects.
ModuleInfoList.ModuleInfoFilter - Interface in io.github.classgraph
Filter an ModuleInfoList using a predicate mapping an ModuleInfo object to a boolean, producing another ModuleInfoList for all items in the list for which the predicate is true.
ModuleReaderProxy - Class in io.github.classgraph
A ModuleReader proxy, written using reflection to preserve backwards compatibility with JDK 7 and 8.
ModuleRef - Class in io.github.classgraph
A ModuleReference proxy, written using reflection to preserve backwards compatibility with JDK 7 and 8.
ModuleRef(Object, Object) - Constructor for class io.github.classgraph.ModuleRef
 

N

nonClassFilesOnly() - Method in class io.github.classgraph.ResourceList
 
NONE - io.github.classgraph.TypeArgument.Wildcard
No wildcard.

O

onFailure(Throwable) - Method in interface io.github.classgraph.ClassGraph.FailureHandler
Called on scanning failure during an asynchronous scan.
open() - Method in class io.github.classgraph.ModuleRef
Open the module, returning a ModuleReaderProxy.
open() - Method in class io.github.classgraph.Resource
Open an InputStream for a classpath resource.
open(String) - Method in class io.github.classgraph.ModuleReaderProxy
Use the proxied ModuleReader to open the named resource as an InputStream.
overrideClassLoaders(ClassLoader...) - Method in class io.github.classgraph.ClassGraph
Completely override (and ignore) system ClassLoaders and the java.class.path system property.
overrideClasspath(Iterable<?>) - Method in class io.github.classgraph.ClassGraph
Override the automatically-detected classpath with a custom path.
overrideClasspath(Object...) - Method in class io.github.classgraph.ClassGraph
Override the automatically-detected classpath with a custom path.
overrideClasspath(String) - Method in class io.github.classgraph.ClassGraph
Override the automatically-detected classpath with a custom path, with path elements separated by File.pathSeparatorChar.
overrideModuleLayers(Object...) - Method in class io.github.classgraph.ClassGraph
Completely override (and ignore) the visible ModuleLayers, and instead scan the requested ModuleLayers.

P

PackageInfo - Class in io.github.classgraph
Holds metadata about a package encountered during a scan.
PackageInfoList - Class in io.github.classgraph
A list of PackageInfo objects.
PackageInfoList.PackageInfoFilter - Interface in io.github.classgraph
Filter an PackageInfoList using a predicate mapping an PackageInfo object to a boolean, producing another PackageInfoList for all items in the list for which the predicate is true.
processScanResult(ScanResult) - Method in interface io.github.classgraph.ClassGraph.ScanResultProcessor
Process the result of an asynchronous scan after scanning has completed.

R

read() - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
read() - Method in class io.github.classgraph.Resource
Open a ByteBuffer for a classpath resource.
read(byte[]) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
read(byte[], int, int) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
read(String) - Method in class io.github.classgraph.ModuleReaderProxy
Use the proxied ModuleReader to open the named resource as a ByteBuffer.
ReferenceTypeSignature - Class in io.github.classgraph
A type signature for a reference type.
ReferenceTypeSignature() - Constructor for class io.github.classgraph.ReferenceTypeSignature
 
release(ByteBuffer) - Method in class io.github.classgraph.ModuleReaderProxy
Release a ByteBuffer allocated by calling ModuleReaderProxy.read(String).
removeTemporaryFilesAfterScan() - Method in class io.github.classgraph.ClassGraph
Remove temporary files, including nested jarfiles (jarfiles within jarfiles, which have to be extracted during scanning in order to be read) from their temporary directory as soon as the scan has completed.
reset() - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
resolve() - Method in class io.github.classgraph.TypeVariableSignature
Look up a type variable (e.g.
Resource - Class in io.github.classgraph
A classpath or module path resource (i.e.
Resource() - Constructor for class io.github.classgraph.Resource
 
Resource.InputStreamResourceCloser - Class in io.github.classgraph
Class for closing the parent Resource when an InputStream opened on the resource is closed.
ResourceList - Class in io.github.classgraph
An AutoCloseable list of AutoCloseable Resource objects.
ResourceList.ByteArrayConsumer - Interface in io.github.classgraph
A FunctionalInterface for consuming the contents of a Resource as a byte array.
ResourceList.ByteBufferConsumer - Interface in io.github.classgraph
A FunctionalInterface for consuming the contents of a Resource as a ByteBuffer.
ResourceList.InputStreamConsumer - Interface in io.github.classgraph
A FunctionalInterface for consuming the contents of a Resource as an InputStream.
ResourceList.ResourceFilter - Interface in io.github.classgraph
Filter a ResourceList using a predicate mapping a Resource object to a boolean, producing another ResourceList for all items in the list for which the predicate is true.

S

scan() - Method in class io.github.classgraph.ClassGraph
Scans the classpath, blocking until the scan is complete.
scan(int) - Method in class io.github.classgraph.ClassGraph
Scans the classpath with the requested number of threads, blocking until the scan is complete.
scan(ExecutorService, int) - Method in class io.github.classgraph.ClassGraph
Scans the classpath using the requested ExecutorService and the requested degree of parallelism, blocking until the scan is complete.
scanAsync(ExecutorService, int) - Method in class io.github.classgraph.ClassGraph
Asynchronously scans the classpath for matching files, returning a Future<ScanResult>.
scanAsync(ExecutorService, int, ClassGraph.ScanResultProcessor, ClassGraph.FailureHandler) - Method in class io.github.classgraph.ClassGraph
Asynchronously scans the classpath, calling a ClassGraph.ScanResultProcessor callback on success or a ClassGraph.FailureHandler callback on failure.
ScanResult - Class in io.github.classgraph
The result of a scan.
setScanResult(ScanResult) - Method in class io.github.classgraph.MethodParameterInfo
 
skip(long) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
 
SUPER - io.github.classgraph.TypeArgument.Wildcard
super

T

toJSON() - Method in class io.github.classgraph.ScanResult
Serialize a ScanResult to minified (un-indented) JSON.
toJSON(int) - Method in class io.github.classgraph.ScanResult
Serialize a ScanResult to JSON.
toString() - Method in class io.github.classgraph.AnnotationClassRef
 
toString() - Method in class io.github.classgraph.AnnotationEnumValue
 
toString() - Method in class io.github.classgraph.AnnotationInfo
 
toString() - Method in class io.github.classgraph.AnnotationParameterValue
 
toString() - Method in class io.github.classgraph.ArrayTypeSignature
 
toString() - Method in class io.github.classgraph.BaseTypeSignature
 
toString() - Method in class io.github.classgraph.ClassInfo
 
toString() - Method in class io.github.classgraph.ClassInfoList
 
toString() - Method in class io.github.classgraph.ClassRefTypeSignature
Return the class type as a string.
toString() - Method in class io.github.classgraph.ClassTypeSignature
 
toString() - Method in class io.github.classgraph.FieldInfo
 
toString() - Method in class io.github.classgraph.MethodInfo
Get a string representation of the method.
toString() - Method in class io.github.classgraph.MethodParameterInfo
 
toString() - Method in class io.github.classgraph.MethodTypeSignature
 
toString() - Method in class io.github.classgraph.ModuleInfo
 
toString() - Method in class io.github.classgraph.ModuleRef
 
toString() - Method in class io.github.classgraph.PackageInfo
 
toString() - Method in class io.github.classgraph.Resource
Return a string representation of the resource's location (as a URL string).
toString() - Method in class io.github.classgraph.ResourceList
 
toString() - Method in class io.github.classgraph.TypeArgument
 
toString() - Method in class io.github.classgraph.TypeParameter
 
toString() - Method in class io.github.classgraph.TypeVariableSignature
 
toStringWithTypeBound() - Method in class io.github.classgraph.TypeVariableSignature
Returns the type variable along with its type bound, if available (e.g.
TypeArgument - Class in io.github.classgraph
A type argument.
TypeArgument.Wildcard - Enum in io.github.classgraph
A type wildcard.
TypeParameter - Class in io.github.classgraph
A type parameter.
TypeSignature - Class in io.github.classgraph
A type signature for a reference type or base type.
TypeSignature() - Constructor for class io.github.classgraph.TypeSignature
 
TypeVariableSignature - Class in io.github.classgraph
A type variable signature.

U

union(ClassInfoList...) - Method in class io.github.classgraph.ClassInfoList
Find the union of this ClassInfoList with one or more others.

V

valueOf(String) - Static method in enum io.github.classgraph.TypeArgument.Wildcard
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.classgraph.TypeArgument.Wildcard
Returns an array containing the constants of this enum type, in the order they are declared.
verbose() - Method in class io.github.classgraph.ClassGraph
Switches on verbose logging to System.err.

W

whitelistClasses(String...) - Method in class io.github.classgraph.ClassGraph
Scan one or more specific classes, without scanning other classes in the same package unless the package is itself whitelisted.
whitelistClasspathElementsContainingResourcePath(String...) - Method in class io.github.classgraph.ClassGraph
Whitelist classpath elements based on resource paths.
whitelistJars(String...) - Method in class io.github.classgraph.ClassGraph
Whitelist one or more jars.
whitelistLibOrExtJars(String...) - Method in class io.github.classgraph.ClassGraph
Whitelist one or more jars in a JRE/JDK "lib/" or "ext/" directory (these directories are not scanned unless ClassGraph.enableSystemPackages() is called, by association with the JRE/JDK).
whitelistModules(String...) - Method in class io.github.classgraph.ClassGraph
Whitelist one or more modules to scan.
whitelistPackages(String...) - Method in class io.github.classgraph.ClassGraph
Scan one or more specific packages and their sub-packages.
whitelistPackagesNonRecursive(String...) - Method in class io.github.classgraph.ClassGraph
Scan one or more specific packages, without recursively scanning sub-packages unless they are themselves whitelisted.
whitelistPaths(String...) - Method in class io.github.classgraph.ClassGraph
Scan one or more specific paths, and their sub-directories or nested paths.
whitelistPathsNonRecursive(String...) - Method in class io.github.classgraph.ClassGraph
Scan one or more specific paths, without recursively scanning sub-directories or nested paths unless they are themselves whitelisted.
A B C D E F G H I L M N O P R S T U V W 
All Classes All Packages