io.github.lukehutch.fastclasspathscanner.scanner

Class RecursiveScanner

java.lang.Object

io.github.lukehutch.fastclasspathscanner.scanner.RecursiveScanner

public class RecursiveScanner
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecursiveScanner.FileMatchProcessorWrapper An interface called when the corresponding FilePathTester returns true.
static interface	RecursiveScanner.FilePathTester An interface used to test whether a file's relative path matches a given specification.

Constructor Summary

Constructors

Constructor and Description
RecursiveScanner(ClasspathFinder classpathFinder, ScanSpec scanSpec) Recursive classpath scanner.

Method Summary

Modifier and Type	Method and Description
void	addFilePathMatcher(RecursiveScanner.FilePathTester filePathTester, RecursiveScanner.FileMatchProcessorWrapper fileMatchProcessorWrapper)
long	classpathContentsLastModifiedTime() Returns the maximum "last modified" timestamp in the classpath (in epoch millis), or zero if scan() has not yet been called (or if nothing was found on the classpath).
boolean	classpathContentsModifiedSinceScan() Returns true if the classpath contents have been changed since scan() was last called.
void	scan() Scans the classpath for matching files, and calls any FileMatchProcessors if a match is identified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecursiveScanner

public RecursiveScanner(ClasspathFinder classpathFinder,
                        ScanSpec scanSpec)

Recursive classpath scanner. Pass in a specification of whitelisted packages/jars to scan and blacklisted packages/jars not to scan, where blacklisted entries are prefixed with the '-' character. Examples of values for scanSpecs: ["com.x"] => scans the package "com.x" and its sub-packages in all directories and jars on the classpath. ["com.x", "-com.x.y"] => scans "com.x" and all sub-packages except "com.x.y" in all directories and jars on the classpath. ["com.x", "-com.x.y", "jar:deploy.jar"] => scans "com.x" and all sub-packages except "com.x.y", but only looks in jars named "deploy.jar" on the classpath (i.e. whitelisting a "jar:" entry prevents non-jar entries from being searched). Note that only the leafname of a jarfile can be specified. ["com.x", "-jar:irrelevant.jar"] => scans "com.x" and all sub-packages in all directories and jars on the classpath *except* "irrelevant.jar" (i.e. blacklisting a jarfile doesn't prevent directories from being scanned the way that whitelisting a jarfile does). ["com.x", "jar:"] => scans "com.x" and all sub-packages, but only looks in jarfiles on the classpath, doesn't scan directories (i.e. all jars are whitelisted, and whitelisting jarfiles prevents non-jars (directories) from being scanned). ["com.x", "-jar:"] => scans "com.x" and all sub-packages, but only looks in directories on the classpath, doesn't scan jarfiles (i.e. all jars are blacklisted.)

Method Detail

addFilePathMatcher

public void addFilePathMatcher(RecursiveScanner.FilePathTester filePathTester,
                               RecursiveScanner.FileMatchProcessorWrapper fileMatchProcessorWrapper)

scan

public void scan()

Scans the classpath for matching files, and calls any FileMatchProcessors if a match is identified.

classpathContentsModifiedSinceScan

public boolean classpathContentsModifiedSinceScan()

Returns true if the classpath contents have been changed since scan() was last called. Only considers classpath prefixes whitelisted in the call to the constructor. Returns true if scan() has not yet been run. Much faster than standard classpath scanning, because only timestamps are checked, and jarfiles don't have to be opened.

classpathContentsLastModifiedTime

public long classpathContentsLastModifiedTime()

Returns the maximum "last modified" timestamp in the classpath (in epoch millis), or zero if scan() has not yet been called (or if nothing was found on the classpath). The returned timestamp should be less than the current system time if the timestamps of files on the classpath and the system time are accurate. Therefore, if anything changes on the classpath, this value should increase.