Class ScanSpec
java.lang.Object
nonapi.io.github.classgraph.scanspec.ScanSpec
The scanning specification.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Whether a path is a descendant of a rejected path, or an ancestor or descendant of an accepted path. -
Field Summary
FieldsModifier and TypeFieldDescriptionIf non-null, specifies manually-added classloaders that should be searched after the context classloader(s).If non-null, specifies manually-added ModuleLayers that should be searched after the visible ModuleLayers.URL schemes that are allowed in classpath elements (not counting the optional "jar:" prefix and/or "file:", which are automatically allowed).Class accept/reject criteria (fully-qualified class names, with separator '.').Classfile accept/reject criteria (path to classfiles, with separator '/', ending in ".class").Package containing accept/reject criteriaed classes (with separator '.').Path to accept/reject criteriaed classes (with separator '/').If non-null, a list of filter operations to apply to classpath elements.Classpath element resource path accept/reject criteria.boolean
If true, don't scan runtime-invisible annotations (only scan annotations with RetentionPolicy.RUNTIME).boolean
If true, enables the saving of annotation info (for class, field, method or method parameter annotations) during the scan.boolean
If true, scan classfile bytecodes, producingClassInfo
objects.boolean
If true, allow external classes (classes outside of accepted packages) to be returned in the ScanResult, if they are directly referred to by an accepted class, as a superclass, implemented interface or annotation.boolean
If true, enables the saving of field info during the scan.boolean
If true, enables the determination of inter-class dependencies.boolean
If true, use aMappedByteBuffer
rather than theFileChannel
API to access file content.boolean
If true, enables the saving of method info during the scan.boolean
If true, all multi-release versions of a resource are found.boolean
Enable the storing of constant initializer values for static final fields in ClassInfo objects.boolean
If true, system jarfiles (rt.jar) and system packages and modules (java.*, jre.*, etc.) should be scanned .boolean
If true, when classes have superclasses, implemented interfaces or annotations that are external classes, those classes are also scanned.boolean
If true, ignore class visibility.boolean
If true, ignore field visibility.boolean
If true, ignore method visibility.boolean
If true, do not fetch paths from parent classloaders.boolean
If true, do not scan module layers that are the parent of other module layers.boolean
Whether to initialize classes when loading them.Jar accept/reject criteria (leafname only, ending in ".jar").lib/ext jar accept/reject criteria (leafname only, ending in ".jar").int
The maximum size of an inner (nested) jar that has been deflated (i.e.Module accept/reject criteria (with separator '.').Commandline module path parameters.If non-null, this list of ClassLoaders will be searched instead of the visible/context ClassLoader(s).If non-null, this list of ModuleLayers will be searched instead of the visible ModuleLayers.Package accept/reject criteria (with separator '.').Package prefix accept/reject criteria, for recursive scanning (with separator '.', ending in '.').Path accept/reject criteria (with separator '/').Path prefix accept/reject criteria, for recursive scanning (with separator '/', ending in '/').boolean
If true, nested jarfiles (jarfiles within jarfiles) that are extracted during scanning are removed from their temporary directory (e.g.boolean
If true, scan directories.boolean
If true, scan jarfiles.boolean
If true, scan modules.boolean
If true, scan nested jarfiles (jarfiles within jarfiles). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addClassLoader
(ClassLoader classLoader) Add a ClassLoader to the list of ClassLoaders to scan.void
addClasspathOverride
(Object overrideClasspathElement) Override the automatically-detected classpath with a custom path.void
addModuleLayer
(Object moduleLayer) Add a ModuleLayer to the list of ModuleLayers to scan.boolean
classfileIsSpecificallyAccepted
(String relativePath) Returns true if the given relative path (for a classfile name, including ".class") matches a specifically-accepted (and non-rejected) classfile's relative path.boolean
classOrPackageIsRejected
(String className) Returns true if the class is specifically rejected, or is within a rejected package.dirAcceptMatchStatus
(String relativePath) Returns true if the given directory path is a descendant of a rejected path, or an ancestor or descendant of an accepted path.void
enableURLScheme
(String scheme) Allow a specified URL scheme in classpath elements.void
filterClasspathElements
(Object filterLambda) Add a classpath element filter.private static boolean
isModuleLayer
(Object moduleLayer) Return true if the argument is a ModuleLayer or a subclass of ModuleLayer.void
Write to log.void
overrideClassLoaders
(ClassLoader... overrideClassLoaders) Completely override the list of ClassLoaders to scan.void
overrideModuleLayers
(Object... overrideModuleLayers) Completely override (and ignore) the visible ModuleLayers, and instead scan the requested ModuleLayers.void
Sort prefixes to ensure correct accept/reject evaluation (see Issue #167).
-
Field Details
-
packageAcceptReject
Package accept/reject criteria (with separator '.'). -
packagePrefixAcceptReject
Package prefix accept/reject criteria, for recursive scanning (with separator '.', ending in '.'). -
pathAcceptReject
Path accept/reject criteria (with separator '/'). -
pathPrefixAcceptReject
Path prefix accept/reject criteria, for recursive scanning (with separator '/', ending in '/'). -
classAcceptReject
Class accept/reject criteria (fully-qualified class names, with separator '.'). -
classfilePathAcceptReject
Classfile accept/reject criteria (path to classfiles, with separator '/', ending in ".class"). -
classPackageAcceptReject
Package containing accept/reject criteriaed classes (with separator '.'). -
classPackagePathAcceptReject
Path to accept/reject criteriaed classes (with separator '/'). -
moduleAcceptReject
Module accept/reject criteria (with separator '.'). -
jarAcceptReject
Jar accept/reject criteria (leafname only, ending in ".jar"). -
classpathElementResourcePathAcceptReject
Classpath element resource path accept/reject criteria. -
libOrExtJarAcceptReject
lib/ext jar accept/reject criteria (leafname only, ending in ".jar"). -
scanJars
public boolean scanJarsIf true, scan jarfiles. -
scanNestedJars
public boolean scanNestedJarsIf true, scan nested jarfiles (jarfiles within jarfiles). -
scanDirs
public boolean scanDirsIf true, scan directories. -
scanModules
public boolean scanModulesIf true, scan modules. -
enableClassInfo
public boolean enableClassInfoIf true, scan classfile bytecodes, producingClassInfo
objects. -
enableFieldInfo
public boolean enableFieldInfoIf true, enables the saving of field info during the scan. This information can be obtained usingClassInfo.getFieldInfo()
. By default, field info is not scanned, for efficiency. -
enableMethodInfo
public boolean enableMethodInfoIf true, enables the saving of method info during the scan. This information can be obtained usingClassInfo.getMethodInfo()
. By default, method info is not scanned, for efficiency. -
enableAnnotationInfo
public boolean enableAnnotationInfoIf true, enables the saving of annotation info (for class, field, method or method parameter annotations) during the scan. This information can be obtained usingClassInfo.getAnnotationInfo()
etc. By default, annotation info is not scanned, for efficiency. -
enableStaticFinalFieldConstantInitializerValues
public boolean enableStaticFinalFieldConstantInitializerValuesEnable the storing of constant initializer values for static final fields in ClassInfo objects. -
enableInterClassDependencies
public boolean enableInterClassDependenciesIf true, enables the determination of inter-class dependencies. -
enableExternalClasses
public boolean enableExternalClassesIf true, allow external classes (classes outside of accepted packages) to be returned in the ScanResult, if they are directly referred to by an accepted class, as a superclass, implemented interface or annotation. Disabled by default. -
enableSystemJarsAndModules
public boolean enableSystemJarsAndModulesIf true, system jarfiles (rt.jar) and system packages and modules (java.*, jre.*, etc.) should be scanned . -
ignoreClassVisibility
public boolean ignoreClassVisibilityIf true, ignore class visibility. If false, classes must be public to be scanned. -
ignoreFieldVisibility
public boolean ignoreFieldVisibilityIf true, ignore field visibility. If false, fields must be public to be scanned. -
ignoreMethodVisibility
public boolean ignoreMethodVisibilityIf true, ignore method visibility. If false, methods must be public to be scanned. -
disableRuntimeInvisibleAnnotations
public boolean disableRuntimeInvisibleAnnotationsIf true, don't scan runtime-invisible annotations (only scan annotations with RetentionPolicy.RUNTIME). -
extendScanningUpwardsToExternalClasses
public boolean extendScanningUpwardsToExternalClassesIf true, when classes have superclasses, implemented interfaces or annotations that are external classes, those classes are also scanned. (Even though this slows down scanning a bit, there is no API for disabling this currently, since disabling it can lead to problems -- see #261.) -
allowedURLSchemes
URL schemes that are allowed in classpath elements (not counting the optional "jar:" prefix and/or "file:", which are automatically allowed). -
addedClassLoaders
If non-null, specifies manually-added classloaders that should be searched after the context classloader(s). -
overrideClassLoaders
If non-null, this list of ClassLoaders will be searched instead of the visible/context ClassLoader(s). In particular, this causes ClassGraph to ignore the java.class.path system property. -
addedModuleLayers
If non-null, specifies manually-added ModuleLayers that should be searched after the visible ModuleLayers. -
overrideModuleLayers
If non-null, this list of ModuleLayers will be searched instead of the visible ModuleLayers. -
overrideClasspath
-
classpathElementFilters
If non-null, a list of filter operations to apply to classpath elements. -
initializeLoadedClasses
public boolean initializeLoadedClassesWhether to initialize classes when loading them. -
removeTemporaryFilesAfterScan
public boolean removeTemporaryFilesAfterScanIf true, nested jarfiles (jarfiles within jarfiles) that are extracted during scanning are removed from their temporary directory (e.g. /tmp/ClassGraph-8JX2u4w) after the scan has completed. If false, temporary files are removed by theScanResult
finalizer, or on JVM exit. -
ignoreParentClassLoaders
public boolean ignoreParentClassLoadersIf true, do not fetch paths from parent classloaders. -
ignoreParentModuleLayers
public boolean ignoreParentModuleLayersIf true, do not scan module layers that are the parent of other module layers. -
modulePathInfo
Commandline module path parameters. -
maxBufferedJarRAMSize
public int maxBufferedJarRAMSizeThe maximum size of an inner (nested) jar that has been deflated (i.e. compressed, not stored) within an outer jar, before it has to be spilled to disk rather than stored in a RAM-backedByteBuffer
when it is deflated, in order for the inner jar's entries to be read. (Note that this situation of having to deflate a nested jar to RAM or disk in order to read it is rare, because normally adding a jarfile to another jarfile will store the inner jar, rather than deflate it, because deflating a jarfile does not usually produce any further compression gains. If an inner jar is stored, not deflated, then its zip entries can be read directly using ClassGraph's own zipfile central directory parser, which can use file slicing to extract entries directly from stored nested jars.)This is also the maximum size of a jar downloaded from an
http://
orhttps://
classpathURL
to RAM. Once this many bytes have been read from theURL
'sInputStream
, then the RAM contents are spilled over to a temporary file on disk, and the rest of the content is downloaded to the temporary file. (This is also rare, because normally there are nohttp://
orhttps://
classpath entries.)Default: 64MB (i.e. writing to disk is avoided wherever possible). Setting a lower max RAM size value will decrease ClassGraph's memory usage if either of the above rare situations occurs.
-
enableMemoryMapping
public boolean enableMemoryMappingIf true, use aMappedByteBuffer
rather than theFileChannel
API to access file content. -
enableMultiReleaseVersions
public boolean enableMultiReleaseVersionsIf true, all multi-release versions of a resource are found.
-
-
Constructor Details
-
ScanSpec
public ScanSpec()Constructor for deserialization.
-
-
Method Details
-
sortPrefixes
public void sortPrefixes()Sort prefixes to ensure correct accept/reject evaluation (see Issue #167). -
addClasspathOverride
Override the automatically-detected classpath with a custom path. You can specify multiple elements in separate calls, and if this method is called even once, the default classpath will be overridden, such that nothing but the provided classpath will be scanned, i.e. causes ClassLoaders to be ignored, as well as the java.class.path system property.- Parameters:
overrideClasspathElement
- The classpath element to add as an override to the default classpath.
-
filterClasspathElements
Add a classpath element filter. The providedClassGraph.ClasspathElementFilter
orClassGraph.ClasspathElementURLFilter
should return true if the path string orURL
passed to it is a path that should be scanned.- Parameters:
filterLambda
- The classpath element filter to apply to all discovered classpath elements, to decide which should be scanned.
-
addClassLoader
Add a ClassLoader to the list of ClassLoaders to scan. (This only works if overrideClasspath() is not called.)- Parameters:
classLoader
- The classloader to add.
-
enableURLScheme
Allow a specified URL scheme in classpath elements.- Parameters:
scheme
- the scheme, e.g. "http".
-
overrideClassLoaders
Completely override the list of ClassLoaders to scan. (This only works if overrideClasspath() is not called.) Causes the java.class.path system property to be ignored.- Parameters:
overrideClassLoaders
- The classloaders to override the default context classloaders with.
-
isModuleLayer
Return true if the argument is a ModuleLayer or a subclass of ModuleLayer.- Parameters:
moduleLayer
- the module layer- Returns:
- true if the argument is a ModuleLayer or a subclass of ModuleLayer.
-
addModuleLayer
Add a ModuleLayer to the list of ModuleLayers to scan. Use this method if you define your own ModuleLayer, but the scanning code is not running within that custom ModuleLayer.This call is ignored if it is called before
overrideModuleLayers(Object...)
.- Parameters:
moduleLayer
- The additional ModuleLayer to scan. (The parameter is of typeObject
for backwards compatibility with JDK 7 and JDK 8, but the argument should be of type ModuleLayer.)
-
overrideModuleLayers
Completely override (and ignore) the visible ModuleLayers, and instead scan the requested ModuleLayers.This call is ignored if overrideClasspath() is called.
- Parameters:
overrideModuleLayers
- The ModuleLayers to scan instead of the automatically-detected ModuleLayers. (The parameter is of typeObject
[] for backwards compatibility with JDK 7 and JDK 8, but the argument should be of type ModuleLayer[].)
-
dirAcceptMatchStatus
Returns true if the given directory path is a descendant of a rejected path, or an ancestor or descendant of an accepted path. The path should end in "/".- Parameters:
relativePath
- the relative path- Returns:
- the
ScanSpec.ScanSpecPathMatch
-
classfileIsSpecificallyAccepted
Returns true if the given relative path (for a classfile name, including ".class") matches a specifically-accepted (and non-rejected) classfile's relative path.- Parameters:
relativePath
- the relative path- Returns:
- true if the given relative path (for a classfile name, including ".class") matches a specifically-accepted (and non-rejected) classfile's relative path.
-
classOrPackageIsRejected
Returns true if the class is specifically rejected, or is within a rejected package.- Parameters:
className
- the class name- Returns:
- true if the class is specifically rejected, or is within a rejected package.
-
log
Write to log.- Parameters:
log
- TheLogNode
to log to.
-