Package io.github.classgraph

Interface Summary

Interface	Description
AnnotationInfoList.AnnotationInfoFilter	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.
Classfile.ClassTypeAnnotationDecorator
Classfile.MethodTypeAnnotationDecorator
Classfile.TypeAnnotationDecorator
ClassGraph.ClasspathElementFilter	Add a classpath element filter.
ClassGraph.ClasspathElementURLFilter	Add a classpath element URL filter.
ClassGraph.FailureHandler	A callback used to handle failure during an asynchronous scan.
ClassGraph.ScanResultProcessor	A callback used to process the result of a successful asynchronous scan.
ClassInfoList.ClassInfoFilter	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.
FieldInfoList.FieldInfoFilter	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.
HasName	A named object.
MethodInfoList.MethodInfoFilter	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.
ModuleInfoList.ModuleInfoFilter	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.
PackageInfoList.PackageInfoFilter	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.
ResourceList.ByteArrayConsumer	A FunctionalInterface for consuming the contents of a Resource as a byte array.
ResourceList.ByteArrayConsumerThrowsIOException	A FunctionalInterface for consuming the contents of a Resource as a byte array, throwing IOException to the caller if an IO exception occurs.
ResourceList.ByteBufferConsumer	A FunctionalInterface for consuming the contents of a Resource as a ByteBuffer.
ResourceList.ByteBufferConsumerThrowsIOException	A FunctionalInterface for consuming the contents of a Resource as a ByteBuffer, throwing IOException to the caller if an IO exception occurs.
ResourceList.InputStreamConsumer	A FunctionalInterface for consuming the contents of a Resource as an InputStream.
ResourceList.InputStreamConsumerThrowsIOException	A FunctionalInterface for consuming the contents of a Resource as an InputStream, throwing IOException to the caller if an IO exception occurs.
ResourceList.ResourceFilter	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.

Class Summary

Class	Description
AnnotationClassRef	Stores the type descriptor of a Class<?>, as found in an annotation parameter value.
AnnotationEnumValue	Class for wrapping an enum constant value (split into class name and constant name), as used as an annotation parameter value.
AnnotationInfo	Holds metadata about a specific annotation instance on a class, method, method parameter or field.
AnnotationInfo.AnnotationInvocationHandler	InvocationHandler for dynamically instantiating an Annotation object.
AnnotationInfoList	A list of AnnotationInfo objects.
AnnotationParameterValue	A wrapper used to pair annotation parameter names with annotation parameter values.
AnnotationParameterValueList	A list of AnnotationParameterValue objects.
ArrayClassInfo	Holds metadata about an array class.
ArrayTypeSignature	An array type signature.
BaseTypeSignature	A type signature for a base type (byte, char, double, float, int, long, short, boolean, or void).
Classfile	A classfile binary format parser.
Classfile.ClassContainment	Class containment.
Classfile.TypePathNode
ClassGraph	Uber-fast, ultra-lightweight Java classpath and module path scanner.
ClassGraphClassLoader	ClassLoader for classes found by ClassGraph during scanning.
ClassInfo	Holds metadata about a class encountered during a scan.
ClassInfo.ReachableAndDirectlyRelatedClasses	A set of classes that indirectly reachable through a directed path, for a given relationship type, and a set of classes that is directly related (only one relationship step away).
ClassInfoList	A uniquified (deduplicated) 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).
ClassMemberInfo	Holds metadata about class members of a class encountered during a scan.
ClasspathElement	A classpath element (a directory or jarfile on the classpath).
ClasspathElementDir	A directory classpath element, using the Path API.
ClasspathElementModule	A module classpath element.
ClasspathElementZip	A zip/jarfile classpath element.
ClassRefOrTypeVariableSignature	A class type or type variable.
ClassRefTypeSignature	A class reference type signature (called "ClassTypeSignature" in the classfile documentation).
ClassTypeSignature	A class type signature (called "ClassSignature" in the classfile documentation).
CloseableByteBuffer	A wrapper for ByteBuffer that implements the Closeable interface, releasing the ByteBuffer when it is no longer needed.
FieldInfo	Holds metadata about fields of a class encountered during a scan.
FieldInfoList	A list of FieldInfo objects.
GraphvizDotfileGenerator	Builds a class graph visualization in Graphviz .dot file format.
HierarchicalTypeSignature	A Java type signature.
InfoList<T extends HasName>	A list of named objects.
MappableInfoList<T extends HasName>	A list of named objects that can be indexed by name.
MethodInfo	Holds metadata about methods of a class encountered during a scan.
MethodInfoList	A list of MethodInfo objects.
MethodParameterInfo	Information on the parameters of a method.
MethodTypeSignature	A method type signature (called "MethodSignature" in the classfile documentation).
ModuleInfo	Holds metadata about a package encountered during a scan.
ModuleInfoList	A list of ModuleInfo objects.
ModulePathInfo	Information on the module path.
ModuleReaderProxy	A ModuleReader proxy, written using reflection to preserve backwards compatibility with JDK 7 and 8.
ModuleRef	A ModuleReference proxy, written using reflection to preserve backwards compatibility with JDK 7 and 8.
ObjectTypedValueWrapper	A union type, used for typesafe serialization/deserialization to/from JSON.
PackageInfo	Holds metadata about a package encountered during a scan.
PackageInfoList	A list of PackageInfo objects.
PotentiallyUnmodifiableList<T>	A potentially unmodifiable list of objects.
ReferenceTypeSignature	A type signature for a reference type.
Resource	A classpath or module path resource (i.e.
ResourceList	An AutoCloseable list of AutoCloseable Resource objects.
Scanner	The classpath scanner.
Scanner.ClassfileScannerWorkUnitProcessor	WorkUnitProcessor for scanning classfiles.
Scanner.ClassfileScanWorkUnit	Used to enqueue classfiles for scanning.
Scanner.ClasspathEntryWorkUnit	Used to enqueue classpath elements for opening.
ScanResult	The result of a scan.
ScanResult.SerializationFormat	A class to hold a serialized ScanResult along with the ScanSpec that was used to scan.
ScanResultObject	A superclass of objects accessible from a ScanResult that are associated with a ClassInfo object.
TypeArgument	A type argument.
TypeParameter	A type parameter.
TypeSignature	A type signature for a reference type or base type.
TypeVariableSignature	A type variable signature.

Enum Summary

Enum	Description
ClassGraph.CircumventEncapsulationMethod	Method to use to attempt to circumvent encapsulation in JDK 16+, in order to get access to a classloader's private classpath.
ClassInfo.ClassType	The class type to return.
ClassInfo.RelType	How classes are related.
TypeArgument.Wildcard	A type wildcard.

Exception Summary

Exception	Description
Classfile.ClassfileFormatException	Thrown when a classfile's contents are not in the correct format.
Classfile.SkipClassException	Thrown when a classfile needs to be skipped.
ClassGraphException	An unchecked exception that is thrown when an error state occurs or an unhandled exception is caught during scanning.