- canRead(File) - Static method in class io.github.classgraph.utils.FileUtils
-
- check() - Method in class io.github.classgraph.utils.InterruptionChecker
-
Check if this thread or any other thread that shares this InterruptionChecker instance has been interrupted
or has thrown an exception, and if so, throw InterruptedException.
- checkAndReturn() - Method in class io.github.classgraph.utils.InterruptionChecker
-
- classfilePathWhiteBlackList - Variable in class io.github.classgraph.ScanSpec
-
Classfile white/blacklist (path to classfiles, with separator '/', ending in ".class").
- classForNameOrNull(String) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Call Class.forName(className), but return null if any exception is thrown.
- 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
-
- ClassLoaderAndModuleFinder - Class in io.github.classgraph.utils
-
A class to find the unique ordered classpath elements.
- ClassLoaderAndModuleFinder(ScanSpec, LogNode) - Constructor for class io.github.classgraph.utils.ClassLoaderAndModuleFinder
-
A class to find the unique ordered classpath elements.
- ClassLoaderHandler - Interface in io.github.classgraph
-
A ClassLoader handler.
- ClassLoaderHandler.DelegationOrder - Enum in io.github.classgraph
-
The delegation order configuration for a given ClassLoader instance (this is usually PARENT_FIRST for most
ClassLoaders, but this can be overridden by some ClassLoaders, e.g.
- classLoaderHandlerClass - Variable in class io.github.classgraph.classloaderhandler.ClassLoaderHandlerRegistry.ClassLoaderHandlerRegistryEntry
-
The ClassLoader class..
- ClassLoaderHandlerRegistry - Class in io.github.classgraph.classloaderhandler
-
The registry for ClassLoaderHandler classes.
- ClassLoaderHandlerRegistry() - Constructor for class io.github.classgraph.classloaderhandler.ClassLoaderHandlerRegistry
-
- ClassLoaderHandlerRegistry.ClassLoaderHandlerRegistryEntry - Class in io.github.classgraph.classloaderhandler
-
A list of fully-qualified ClassLoader class names paired with the ClassLoaderHandler that can handle them.
- ClassLoaderHandlerRegistryEntry(Class<? extends ClassLoaderHandler>) - Constructor for class io.github.classgraph.classloaderhandler.ClassLoaderHandlerRegistry.ClassLoaderHandlerRegistryEntry
-
- classLoaders - Variable in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
The ClassLoader(s) used to load classes for this classpath element
- classNameToClassfilePath(String) - Static method in class io.github.classgraph.utils.WhiteBlackList
-
Convert a class name to a classfile path.
- classPackagePathWhiteBlackList - Variable in class io.github.classgraph.ScanSpec
-
Path to white/blacklisted classes (with separator '/').
- classPackageWhiteBlackList - Variable in class io.github.classgraph.ScanSpec
-
Package containing white/blacklisted classes (with separator '.').
- 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.
- classpathElementFilters - Variable in class io.github.classgraph.ScanSpec
-
If non-null, a list of filter operations to apply to classpath elements.
- classPathEntriesToScan - Variable in class io.github.classgraph.utils.JarfileMetadataReader
-
"Class-Path" entries encountered in the manifest file.
- ClasspathFinder - Class in io.github.classgraph.utils
-
A class to find the unique ordered classpath elements.
- ClasspathFinder(ScanSpec, NestedJarHandler, LogNode) - Constructor for class io.github.classgraph.utils.ClasspathFinder
-
A class to find the unique ordered classpath elements.
- ClasspathOrder - Class in io.github.classgraph.utils
-
A class to find the unique ordered classpath elements.
- ClasspathOrModulePathEntry - Class in io.github.classgraph.utils
-
An entry in the classpath or module path.
- ClasspathOrModulePathEntry(ModuleRef, NestedJarHandler, LogNode) - Constructor for class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
A relative path for a module (in JDK9+).
- ClasspathOrModulePathEntry(String, String, ClassLoader[], NestedJarHandler, ScanSpec, LogNode) - Constructor for class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
A relative path.
- 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).
- classWhiteBlackList - Variable in class io.github.classgraph.ScanSpec
-
Class white/blacklist (fully-qualified class names, with separator '.').
- clear() - Method in class io.github.classgraph.utils.SingletonMap
-
Clear the map.
- 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() - Method in class io.github.classgraph.ResourceList
-
- close() - Method in class io.github.classgraph.ScanResult
-
Free any temporary files created by extracting jars or files from within jars.
- close() - Method in class io.github.classgraph.utils.AutoCloseableExecutorService
-
Shut down thread pool on close().
- close() - Method in class io.github.classgraph.utils.Recycler
-
Calls close() on all the unused instances.
- close() - Method in class io.github.classgraph.utils.Recycler.Recyclable
-
Release/recycle an instance.
- close() - Method in class io.github.classgraph.utils.WorkQueue
-
Ensure that there are no work units still uncompleted.
- close(LogNode) - Method in class io.github.classgraph.utils.NestedJarHandler
-
Close zipfiles and modules, and delete temporary files.
- closeRecyclers() - Method in class io.github.classgraph.utils.NestedJarHandler
-
Close zipfiles and modules.
- 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(ModuleRef) - Method in class io.github.classgraph.ModuleRef
-
- compareTo(Resource) - Method in class io.github.classgraph.Resource
-
- containsName(String) - Method in class io.github.classgraph.AnnotationInfoList
-
- containsName(String) - Method in class io.github.classgraph.ClassInfoList
-
- containsName(String) - Method in class io.github.classgraph.FieldInfoList
-
- containsName(String) - Method in class io.github.classgraph.MethodInfoList
-
- countBytesBeforePKMarker(File) - Static method in class io.github.classgraph.utils.JarUtils
-
Count the number of bytes before the characters "PK" in a zipfile.
- create(InputStream) - Static method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Create a new InputStream adapter.
- create(ByteBuffer) - Static method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Create a new ByteBuffer adapter.
- createSingleton(K, LogNode) - Method in class io.github.classgraph.utils.SingletonMap
-
Initialize a value object for this key and return true, if this is the first time this key has been seen,
otherwise return false.
- createURLClassLoaderFromPathString(String) - Static method in class io.github.classgraph.utils.JarUtils
-
Create a custom URLClassLoader from a classpath path string.
- curr - Variable in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
The current position in the buffer.
- CURR_DIR_PATH - Static variable in class io.github.classgraph.utils.FileUtils
-
The current directory path (only reads the current directory once, the first time this field is accessed, so
will not reflect subsequent changes to the current directory).
- currToken() - Method in class io.github.classgraph.utils.Parser
-
Get the current token, and reset the token to empty.
- 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 - Variable in class io.github.classgraph.ScanSpec
-
If true, enables the saving of annotation info (for class, field, method or method parameter annotations)
during the scan.
- 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 - Variable in class io.github.classgraph.ScanSpec
-
If true, scan classfile bytecodes, producing
ClassInfo objects.
- enableClassInfo() - Method in class io.github.classgraph.ClassGraph
-
- enableExternalClasses - Variable in class io.github.classgraph.ScanSpec
-
If true, allow external classes (classes outside of whitelisted packages) to be returned in the ScanResult,
if they are directly referred to by a whitelisted class, as a superclass, implemented interface or
annotation.
- 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 - Variable in class io.github.classgraph.ScanSpec
-
If true, enables the saving of field info during the scan.
- enableFieldInfo() - Method in class io.github.classgraph.ClassGraph
-
Enables the saving of field info during the scan.
- enableMethodInfo - Variable in class io.github.classgraph.ScanSpec
-
If true, enables the saving of method info during the scan.
- enableMethodInfo() - Method in class io.github.classgraph.ClassGraph
-
Enables the saving of method info during the scan.
- enableStaticFinalFieldConstantInitializerValues - Variable in class io.github.classgraph.ScanSpec
-
Enable the storing of constant initializer values for static final fields in ClassInfo objects.
- enableStaticFinalFieldConstantInitializerValues() - Method in class io.github.classgraph.ClassGraph
-
Enables the saving of static final field constant initializer values.
- enableSystemPackages() - Method in class io.github.classgraph.ClassGraph
-
Enables the scanning of system packages (java.*, jdk.*, oracle.*, etc.) -- these are not scanned by default
for speed.
- encodePath(String) - Static method in class io.github.classgraph.utils.URLPathEncoder
-
Encode a URL path using percent-encoding.
- 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.ModuleRef
-
- 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
-
- equals(Object) - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
Return true based on equality of canonical paths.
- 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
-
- EquinoxClassLoaderHandler - Class in io.github.classgraph.classloaderhandler
-
Extract classpath entries from the Eclipse Equinox ClassLoader.
- EquinoxClassLoaderHandler() - Constructor for class io.github.classgraph.classloaderhandler.EquinoxClassLoaderHandler
-
- EquinoxContextFinderClassLoaderHandler - Class in io.github.classgraph.classloaderhandler
-
Extract classpath entries from the Eclipse Equinox ContextFinder ClassLoader.
- EquinoxContextFinderClassLoaderHandler() - Constructor for class io.github.classgraph.classloaderhandler.EquinoxContextFinderClassLoaderHandler
-
- escapeJSONString(String) - Static method in class io.github.classgraph.json.JSONUtils
-
Escape a string to be surrounded in double quotes in JSON.
- exclude(ClassInfoList) - Method in class io.github.classgraph.ClassInfoList
-
- executionException(Exception) - Method in class io.github.classgraph.utils.InterruptionChecker
-
Stop all threads that share this InterruptionChecker due to an exception being thrown in one of them.
- expect(char) - Method in class io.github.classgraph.utils.Parser
-
Expect the next character.
- EXTENDS - io.github.classgraph.TypeArgument.Wildcard
-
extends
- extendsSuperclass(String) - Method in class io.github.classgraph.ClassInfo
-
- extraClassLoaderHandlers - Variable in class io.github.classgraph.ScanSpec
-
Manually-registered ClassLoaderHandlers.
- 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.
- get() - Method in class io.github.classgraph.utils.Recycler.Recyclable
-
- get(String) - Method in class io.github.classgraph.AnnotationInfoList
-
- get(String) - Method in class io.github.classgraph.ClassInfoList
-
- get(String) - Method in class io.github.classgraph.FieldInfoList
-
- get(String) - Method in class io.github.classgraph.MethodInfoList
-
Returns a list of all methods matching a given name.
- get(K) - Method in class io.github.classgraph.utils.SingletonMap
-
Get the singleton for a given key.
- 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 direct annotations on this method, along with any annotation parameter values, as a list of
AnnotationInfo objects, 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).
- 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
-
- getAnnotationsOnClass(String) - Method in class io.github.classgraph.ScanResult
-
Get annotations on the named class.
- getAsStrings() - Method in class io.github.classgraph.AnnotationInfoList
-
- getAsStrings() - Method in class io.github.classgraph.ClassInfoList
-
- getAsStrings() - Method in class io.github.classgraph.FieldInfoList
-
- getAsStrings() - Method in class io.github.classgraph.MethodInfoList
-
- getBaseClassName() - Method in class io.github.classgraph.ClassRefTypeSignature
-
Get the name of the base class.
- getc() - Method in class io.github.classgraph.utils.Parser
-
Get the next character.
- getCanonicalPath(LogNode) - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- getClassBound() - Method in class io.github.classgraph.TypeParameter
-
Get the type parameter class bound.
- 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.MethodTypeSignature
-
- getClassInfo() - Method in class io.github.classgraph.TypeArgument
-
- getClassInfo() - Method in class io.github.classgraph.TypeParameter
-
- 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 scanning.
- getClassLoader() - Method in class io.github.classgraph.ModuleRef
-
- getClassLoaderAndModuleFinder() - Method in class io.github.classgraph.utils.ClasspathFinder
-
- getClassLoaders() - Method in class io.github.classgraph.utils.ClassLoaderAndModuleFinder
-
- getClassLoaders() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- getClassName() - Method in class io.github.classgraph.AnnotationClassRef
-
- getClassName() - Method in class io.github.classgraph.AnnotationEnumValue
-
- getClassName() - Method in class io.github.classgraph.AnnotationInfo
-
- 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
-
- getClassName() - Method in class io.github.classgraph.ClassTypeSignature
-
- getClassName() - Method in class io.github.classgraph.FieldInfo
-
Returns the defining class name, so that super.getClassInfo() returns the
ClassInfo object for the
defining class.
- getClassName() - Method in class io.github.classgraph.MethodInfo
-
Returns the defining class name, so that super.getClassInfo() returns the
ClassInfo object for the
defining 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.
- getClassNamesFromTypeDescriptors(Set<String>) - Method in class io.github.classgraph.AnnotationClassRef
-
- getClassNamesFromTypeDescriptors(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.
- getClassNamesFromTypeDescriptors(Set<String>) - Method in class io.github.classgraph.FieldInfo
-
Get the names of any classes in the type descriptor or type signature.
- getClassNamesFromTypeDescriptors(Set<String>) - Method in class io.github.classgraph.MethodInfo
-
Get the names of any classes in the type descriptor or type signature.
- 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
-
- getClasspathElementURL() - Method in class io.github.classgraph.ClassInfo
-
- 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 of the class.
- getDefaultParameterValues() - Method in class io.github.classgraph.AnnotationInfo
-
- getDefiningClassInfo() - Method in class io.github.classgraph.FieldInfo
-
Get the class this field is defined within.
- getDefiningClassInfo() - Method in class io.github.classgraph.MethodInfo
-
Get the class this method is defined within.
- getDefiningClassName() - Method in class io.github.classgraph.FieldInfo
-
Get the name of the class this field is defined within.
- getDefiningClassName() - Method in class io.github.classgraph.MethodInfo
-
Get the name of the class this method is defined within.
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.AntClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.EquinoxClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.EquinoxContextFinderClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.FallbackClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.FelixClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in interface io.github.classgraph.ClassLoaderHandler
-
The delegation order configuration for a given ClassLoader instance (this is usually PARENT_FIRST for most
ClassLoaders, since you don't generally want to be able to override system classes with user classes, but
this can be overridden by some ClassLoaders, e.g.
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.JBossClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.JPMSClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.OSGiDefaultClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.URLClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.WeblogicClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.WebsphereLibertyClassLoaderHandler
-
- getDelegationOrder(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.WebsphereTraditionalClassLoaderHandler
-
- getDescriptor() - Method in class io.github.classgraph.ModuleRef
-
- getElementTypeSignature() - Method in class io.github.classgraph.ArrayTypeSignature
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.AntClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.EquinoxClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.EquinoxContextFinderClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.FallbackClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.FelixClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in interface io.github.classgraph.ClassLoaderHandler
-
If this ClassLoader delegates directly to an embedded classloader instance, return it here, otherwise return
null.
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.JBossClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.JPMSClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.OSGiDefaultClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.URLClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.WeblogicClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.WebsphereLibertyClassLoaderHandler
-
- getEmbeddedClassLoader(ClassLoader) - Method in class io.github.classgraph.classloaderhandler.WebsphereTraditionalClassLoaderHandler
-
- getEnums() - Method in class io.github.classgraph.ClassInfoList
-
- getFieldAnnotations() - Method in class io.github.classgraph.ClassInfo
-
- getFieldInfo() - Method in class io.github.classgraph.ClassInfo
-
Returns information on all visible fields of the class.
- getFieldInfo(String) - Method in class io.github.classgraph.ClassInfo
-
Returns information on a given visible field of the class.
- getFieldVal(Object, String, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Get the value of the named field in the class of the given object or any of its superclasses.
- getFile(LogNode) - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- 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
-
- getIdentifierToken(Parser) - Static method in class io.github.classgraph.utils.TypeUtils
-
Parse a Java identifier part (between separators and other non-alphanumeric characters).
- getIdentifierToken(Parser, char, char) - Static method in class io.github.classgraph.utils.TypeUtils
-
Parse a Java identifier with the given separator ('.' or '/').
- 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
-
- getInnermostNestedJar(String, LogNode) - Method in class io.github.classgraph.utils.NestedJarHandler
-
Get a File for a given (possibly nested) jarfile path, unzipping the first N-1 segments of an N-segment
'!'-delimited path to temporary files, then returning the File reference for the N-th temporary file.
- 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).
- getJarfileMetadataReader(File, String, LogNode) - Method in class io.github.classgraph.utils.NestedJarHandler
-
Get a
JarfileMetadataReader singleton for a given jarfile (so that the manifest and ZipEntries will
only be read once).
- getJarfilePackageRoot() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- getJreJarPaths() - Static method in class io.github.classgraph.utils.JarUtils
-
- getJreLibOrExtJars() - Static method in class io.github.classgraph.utils.JarUtils
-
- getLayer() - Method in class io.github.classgraph.ModuleRef
-
- getLength() - Method in class io.github.classgraph.Resource
-
- 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 methods and constructors of the class.
- getMethodAnnotations() - Method in class io.github.classgraph.ClassInfo
-
- getMethodInfo() - Method in class io.github.classgraph.ClassInfo
-
Returns information on visible methods of the class that are not constructors.
- getMethodInfo(String) - Method in class io.github.classgraph.ClassInfo
-
Returns information on the method(s) or constructor(s) of the class with the given method name.
- 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.
- getModuleReaderProxyRecycler(ModuleRef, LogNode) - Method in class io.github.classgraph.utils.NestedJarHandler
-
Get a ModuleReaderProxy recycler given a ModuleRef.
- getModuleRef() - Method in class io.github.classgraph.ClassInfo
-
- getModuleRef() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- 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
-
Returns the name of the field.
- 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.ModuleRef
-
- 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.AnnotationInfoList
-
- getNames() - Method in class io.github.classgraph.ClassInfoList
-
- getNames() - Method in class io.github.classgraph.FieldInfoList
-
- getNames() - Method in class io.github.classgraph.MethodInfoList
-
- getNonSystemModuleRefs() - Method in class io.github.classgraph.utils.ClassLoaderAndModuleFinder
-
- getNumDimensions() - Method in class io.github.classgraph.ArrayTypeSignature
-
- getOrCreateSingleton(K, LogNode) - Method in class io.github.classgraph.utils.SingletonMap
-
Check if the given key is in the map, and if so, return it.
- getOuterClasses() - Method in class io.github.classgraph.ClassInfo
-
- getOutermostJar(File) - Method in class io.github.classgraph.utils.NestedJarHandler
-
Given a File reference for an inner nested jarfile, find the outermost jarfile it was extracted from.
- 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
-
- 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
-
- getPosition() - Method in class io.github.classgraph.utils.Parser
-
- getPositionInfo() - Method in class io.github.classgraph.utils.Parser
-
- getRawClasspathElements() - Method in class io.github.classgraph.utils.ClasspathFinder
-
- getReference() - Method in class io.github.classgraph.ModuleRef
-
- getResolvedPath() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- 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
-
- getResultType() - Method in class io.github.classgraph.MethodTypeSignature
-
Get the result type for the method.
- 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).
- getState() - Method in class io.github.classgraph.utils.Parser
-
Get the "state object" from the parser (can be used to parse state between parser functions).
- getStaticFieldVal(Class<?>, String, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Get the value of the named static field in the given class or any of its superclasses.
- 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.
- getSubsequence(int, int) - Method in class io.github.classgraph.utils.Parser
-
Return a subsequence of the input string.
- getSubstring(int, int) - Method in class io.github.classgraph.utils.Parser
-
Return a substring of the input string.
- 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
- getSystemModuleRefs() - Method in class io.github.classgraph.utils.ClassLoaderAndModuleFinder
-
- 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.
- getVersion() - Static method in class io.github.classgraph.utils.VersionFinder
-
- getWildcard() - Method in class io.github.classgraph.TypeArgument
-
Get the type wildcard, which is one of {NONE, ANY, EXTENDS, SUPER}.
- getZipFileRecycler(File, LogNode) - Method in class io.github.classgraph.utils.NestedJarHandler
-
Get a ZipFile recycler given the (non-nested) canonical path of a jarfile.
- globToPattern(String) - Static method in class io.github.classgraph.utils.WhiteBlackList
-
Convert a spec with a '*' glob character into a regular expression.
- Id - Annotation Type in io.github.classgraph.json
-
Annotate a class field with this annotation to use that field's value instead of the automatically-generated id
for object references in JSON output.
- ignoreClassVisibility - Variable in class io.github.classgraph.ScanSpec
-
If true, ignore class visibility.
- 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 - Variable in class io.github.classgraph.ScanSpec
-
If true, ignore field visibility.
- 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 - Variable in class io.github.classgraph.ScanSpec
-
If true, ignore method visibility.
- 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 - Variable in class io.github.classgraph.ScanSpec
-
If true, do not fetch paths from parent classloaders.
- ignoreParentClassLoaders() - Method in class io.github.classgraph.ClassGraph
-
Ignore parent classloaders (i.e.
- implementsInterface(String) - Method in class io.github.classgraph.ClassInfo
-
- includeClasspathElement(String) - Method in interface io.github.classgraph.ClassGraph.ClasspathElementFilter
-
- initializeLoadedClasses - Variable in class io.github.classgraph.ScanSpec
-
If true, classes loaded with Class.forName() are initialized before passing class references to
MatchProcessors.
- 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
-
- InputStreamOrByteBufferAdapter - Class in io.github.classgraph.utils
-
Buffer class that can wrap either an InputStream or a ByteBuffer, depending on which is available.
- 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
-
- instantiate(LogNode) - Method in class io.github.classgraph.classloaderhandler.ClassLoaderHandlerRegistry.ClassLoaderHandlerRegistryEntry
-
Instantiate a ClassLoaderHandler, or return null if the class could not be instantiated.
- interrupt() - Method in class io.github.classgraph.utils.InterruptionChecker
-
Interrupt all threads that share this InterruptionChecker.
- InterruptionChecker - Class in io.github.classgraph.utils
-
Check if this thread or any other thread that shares this InterruptionChecker instance has been interrupted or
has thrown an exception.
- InterruptionChecker() - Constructor for class io.github.classgraph.utils.InterruptionChecker
-
- intersect(ClassInfoList...) - Method in class io.github.classgraph.ClassInfoList
-
Find the intersection of this
ClassInfoList with one or more others.
- invokeDefaultMethod(Class<?>, String, Class<?>, ClassLoader, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Invoke the named default interface method.
- invokeMethod(Object, String, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Invoke the named method in the given object or its superclasses.
- invokeMethod(Object, String, Class<?>, Object, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Invoke the named method in the given object or its superclasses.
- invokeStaticMethod(Class<?>, String, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Invoke the named static method.
- invokeStaticMethod(Class<?>, String, Class<?>, Object, boolean) - Static method in class io.github.classgraph.utils.ReflectionUtils
-
Invoke the named static method.
- io.github.classgraph - package io.github.classgraph
-
- io.github.classgraph.classloaderhandler - package io.github.classgraph.classloaderhandler
-
- io.github.classgraph.json - package io.github.classgraph.json
-
- io.github.classgraph.utils - package io.github.classgraph.utils
-
- isAbstract() - Method in class io.github.classgraph.ClassInfo
-
- isAnnotation() - Method in class io.github.classgraph.ClassInfo
-
- isAnonymousInnerClass() - Method in class io.github.classgraph.ClassInfo
-
- isBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList
-
- isBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListLeafname
-
Check if the requested string is blacklisted.
- isBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListPrefix
-
Check if the requested string has a blacklisted prefix.
- isBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListWholeString
-
Check if the requested string is blacklisted.
- isBridge() - Method in class io.github.classgraph.MethodInfo
-
Returns true if this method is a bridge method.
- isClassfile() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- isClassfile(String) - Static method in class io.github.classgraph.utils.FileUtils
-
- isConstructor() - Method in class io.github.classgraph.MethodInfo
-
Returns true if this method is a constructor.
- isDirectory(LogNode) - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- isEnum() - Method in class io.github.classgraph.ClassInfo
-
- isExternalClass() - Method in class io.github.classgraph.ClassInfo
-
- isFile(LogNode) - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- 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.
- isHttpURL() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- 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
-
- isInSystemPackageOrModule(String) - Static method in class io.github.classgraph.utils.JarUtils
-
Return true if the given class name, package name or module name has a system package or module prefix
- isInterface() - Method in class io.github.classgraph.ClassInfo
-
- isInterfaceOrAnnotation() - Method in class io.github.classgraph.ClassInfo
-
- isJREJar(String, ScanSpec, LogNode) - Static method in class io.github.classgraph.utils.JarUtils
-
- isJrtURL() - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
- isNative() - Method in class io.github.classgraph.MethodInfo
-
Returns true if this method is a native method.
- 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.
- isSpecificallyWhitelisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList
-
- isSpecificallyWhitelistedAndNotBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList
-
- 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
-
- isSystemJar - Variable in class io.github.classgraph.utils.JarfileMetadataReader
-
If true, this is a JRE jar.
- 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.
- isValidClasspathElement(ScanSpec, LogNode) - Method in class io.github.classgraph.utils.ClasspathOrModulePathEntry
-
True if this relative path is a valid classpath element: that its path can be canonicalized, that it exists,
that it is a jarfile or directory, that it is not a blacklisted jar, that it should be scanned, etc.
- isVarArgs() - Method in class io.github.classgraph.MethodInfo
-
Returns true if this method is a varargs method.
- isWhitelisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList
-
- isWhitelisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListLeafname
-
Check if the requested string is whitelisted.
- isWhitelisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListPrefix
-
Check if the requested string has a whitelisted prefix.
- isWhitelisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListWholeString
-
Check if the requested string is whitelisted.
- isWhitelistedAndNotBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList
-
- isWhitelistedAndNotBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListLeafname
-
Check if the requested string is whitelisted and not blacklisted.
- isWhitelistedAndNotBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListPrefix
-
Check if the requested string has a whitelisted/non-blacklisted prefix.
- isWhitelistedAndNotBlacklisted(String) - Method in class io.github.classgraph.utils.WhiteBlackList.WhiteBlackListWholeString
-
Check if the requested string is whitelisted and not blacklisted.
- read() - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
-
- read() - Method in class io.github.classgraph.Resource
-
- read(byte[]) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
-
- read(byte[], int, int) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
-
- read(byte[], int, int) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Copy up to len bytes into the byte array, starting at the given offset.
- read(String) - Method in class io.github.classgraph.ModuleReaderProxy
-
Use the proxied ModuleReader to open the named resource as a ByteBuffer.
- readAllBytesAsArray(InputStream, long, LogNode) - Static method in class io.github.classgraph.utils.FileUtils
-
- readAllBytesAsString(InputStream, long, LogNode) - Static method in class io.github.classgraph.utils.FileUtils
-
- readInitialChunk() - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Read an initial chunk of the file into the buffer.
- readInt() - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
- readInt(int) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Read an int from the buffer at a specific absolute offset before the current read point.
- readLong() - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
- readLong(int) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Read a long from the buffer at a specific offset before the current read point.
- readString(int, boolean, boolean) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Reads the "modified UTF8" format defined in the Java classfile spec, optionally replacing '/' with '.', and
optionally removing the prefix "L" and the suffix ";".
- readUnsignedByte() - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Read an unsigned byte from the buffer.
- readUnsignedByte(int) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Read an unsigned byte from the buffer at a specific absolute offset before the current read point.
- readUnsignedShort() - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
- readUnsignedShort(int) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Read an unsigned short from the buffer at a specific absolute offset before the current read point.
- Recyclable() - Constructor for class io.github.classgraph.utils.Recycler.Recyclable
-
Acquire or allocate an instance.
- Recycler<T extends Closeable,E extends Exception> - Class in io.github.classgraph.utils
-
Recycle instances of type T.
- Recycler() - Constructor for class io.github.classgraph.utils.Recycler
-
- Recycler.Recyclable - Class in io.github.classgraph.utils
-
An AutoCloseable wrapper for a recyclable object instance.
- ReferenceTypeSignature - Class in io.github.classgraph
-
A type signature for a reference type.
- ReferenceTypeSignature() - Constructor for class io.github.classgraph.ReferenceTypeSignature
-
- ReflectionUtils - Class in io.github.classgraph.utils
-
Reflection utility methods that can be used by ClassLoaderHandlers.
- ReflectionUtils() - Constructor for class io.github.classgraph.utils.ReflectionUtils
-
- registerClassLoaderHandler(Class<? extends ClassLoaderHandler>) - Method in class io.github.classgraph.ClassGraph
-
Register an extra ClassLoaderHandler.
- registerClassLoaderHandler(Class<? extends ClassLoaderHandler>) - Method in class io.github.classgraph.ScanSpec
-
Register an extra ClassLoaderHandler.
- release(ByteBuffer) - Method in class io.github.classgraph.ModuleReaderProxy
-
- removeTemporaryFilesAfterScan - Variable in class io.github.classgraph.ScanSpec
-
If true, nested jarfiles (jarfiles within jarfiles) that are extracted during scanning are removed from their
temporary directory (e.g.
- 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.
- resolve(String) - Static method in class io.github.classgraph.utils.FastPathResolver
-
Strip away any "jar:" prefix from a filename URI, and convert it to a file path, handling possibly-broken
mixes of filesystem and URI conventions.
- resolve(String, String) - Static method in class io.github.classgraph.utils.FastPathResolver
-
Strip away any "jar:" prefix from a filename URI, and convert it to a file path, handling possibly-broken
mixes of filesystem and URI conventions; resolve relative paths relative to resolveBasePath.
- 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
-
- ResourceList - Class in io.github.classgraph
-
An AutoCloseable list of AutoCloseable
Resource objects.
- ResourceList.ByteArrayConsumer - Interface in io.github.classgraph
-
- ResourceList.ByteBufferConsumer - Interface in io.github.classgraph
-
- ResourceList.InputStreamConsumer - Interface in io.github.classgraph
-
- 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.
- runWorkQueue(Collection<U>, ExecutorService, int, WorkQueue.WorkUnitProcessor<U>, InterruptionChecker, LogNode) - Static method in class io.github.classgraph.utils.WorkQueue
-
Start a work queue on the elements in the provided collection, blocking until all work units have been
completed.
- runWorkQueue(Collection<U>, ExecutorService, int, WorkQueue.WorkUnitProcessor<U>, WorkQueue.WorkQueuePreStartHook<U>, InterruptionChecker, LogNode) - Static method in class io.github.classgraph.utils.WorkQueue
-
Start a work queue on the elements in the provided collection, blocking until all work units have been
completed.
- scan() - Method in class io.github.classgraph.ClassGraph
-
Scans the classpath for matching files, and calls any MatchProcessors if a match is identified.
- scan(int) - Method in class io.github.classgraph.ClassGraph
-
Scans the classpath for matching files, and calls any MatchProcessors if a match is identified.
- scan(ExecutorService, int) - Method in class io.github.classgraph.ClassGraph
-
Scans the classpath for matching files, and calls any MatchProcessors if a match is identified.
- scanAsync(ExecutorService, int) - Method in class io.github.classgraph.ClassGraph
-
Asynchronously scans the classpath for matching files, and calls any MatchProcessors if a match is
identified.
- scanAsync(ExecutorService, int, ClassGraph.ScanResultProcessor, ClassGraph.FailureHandler) - Method in class io.github.classgraph.ClassGraph
-
Asynchronously scans the classpath for matching files, and if runAsynchronously is true, also calls any
MatchProcessors if a match is identified.
- scanDirs - Variable in class io.github.classgraph.ScanSpec
-
If true, scan directories.
- scanJars - Variable in class io.github.classgraph.ScanSpec
-
If true, scan jarfiles.
- scanModules - Variable in class io.github.classgraph.ScanSpec
-
If true, scan modules.
- scanNestedJars - Variable in class io.github.classgraph.ScanSpec
-
If true, scan nested jarfiles (jarfiles within jarfiles).
- ScanResult - Class in io.github.classgraph
-
The result of a scan.
- ScanSpec - Class in io.github.classgraph
-
Parses the scanning specification that was passed to the ClassGraph constructor, and finds all ClassLoaders.
- serializeFromField(Object, String, int, boolean) - Static method in class io.github.classgraph.json.JSONSerializer
-
Recursively serialize the named field of an object, skipping transient and final fields.
- serializeFromField(Object, String, int, boolean, ClassFieldCache) - Static method in class io.github.classgraph.json.JSONSerializer
-
Recursively serialize the named field of an object, skipping transient and final fields.
- serializeObject(Object) - Static method in class io.github.classgraph.json.JSONSerializer
-
Recursively serialize an Object (or array, list, map or set of objects) to JSON, skipping transient and final
fields.
- serializeObject(Object, int, boolean) - Static method in class io.github.classgraph.json.JSONSerializer
-
Recursively serialize an Object (or array, list, map or set of objects) to JSON, skipping transient and final
fields.
- serializeObject(Object, int, boolean, ClassFieldCache) - Static method in class io.github.classgraph.json.JSONSerializer
-
Recursively serialize an Object (or array, list, map or set of objects) to JSON, skipping transient and final
fields.
- setPosition(int) - Method in class io.github.classgraph.utils.Parser
-
Set the position of the parser within the string.
- setScanResult(ScanResult) - Method in class io.github.classgraph.MethodParameterInfo
-
- setState(Object) - Method in class io.github.classgraph.utils.Parser
-
Set the "state object" from the parser (can be used to parse state between parser functions).
- SimpleThreadFactory - Class in io.github.classgraph.utils
-
Simple implementation of a thread factory.
- SimpleThreadFactory(String, boolean) - Constructor for class io.github.classgraph.utils.SimpleThreadFactory
-
Constructor.
- SingletonMap<K,V> - Class in io.github.classgraph.utils
-
A map from keys to singleton instances.
- SingletonMap() - Constructor for class io.github.classgraph.utils.SingletonMap
-
- skip(int) - Method in class io.github.classgraph.utils.InputStreamOrByteBufferAdapter
-
Skip the given number of bytes in the input stream.
- skip(long) - Method in class io.github.classgraph.Resource.InputStreamResourceCloser
-
- skipWhitespace() - Method in class io.github.classgraph.utils.Parser
-
Skip whitespace starting at the current position.
- smartPathSplit(String) - Static method in class io.github.classgraph.utils.JarUtils
-
Split a path on File.pathSeparator (':' on Linux, ';' on Windows), but also allow for the use of URLs with
protocol specifiers, e.g.
- sortPrefixes() - Method in class io.github.classgraph.utils.WhiteBlackList
-
Need to sort prefixes to ensure correct whitelist/blacklist evaluation (see Issue #167).
- stripSFXHeader - Variable in class io.github.classgraph.ScanSpec
-
If true, manually strip the self extracting executable header from zipfiles (i.e.
- stripSFXHeader(File, long, File) - Static method in class io.github.classgraph.utils.JarUtils
-
Strip the self-extracting archive header from the beginning of a zipfile.
- stripZipSFXHeaders() - Method in class io.github.classgraph.ClassGraph
-
Manually strip the self extracting executable header from zipfiles (i.e.
- SUPER - io.github.classgraph.TypeArgument.Wildcard
-
super
- SYSTEM_PACKAGE_PATH_PREFIXES - Static variable in class io.github.classgraph.utils.JarUtils
-
Prefixes of system (JRE) packages, turned into path form (with slashes instead of dots).
- SYSTEM_PACKAGE_PREFIXES - Static variable in class io.github.classgraph.utils.JarUtils
-
Prefixes of system (JRE) packages.