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 class	RecursiveScanner.FilePathMatcher A class used for associating a FilePathTester with a FileMatchProcessor.
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 classpath, String[] whitelistedPaths, String[] blacklistedPaths)

Method Summary

Modifier and Type	Method and Description
void	addFilePathMatcher(RecursiveScanner.FilePathMatcher filePathMatcher)
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(boolean scanTimestampsOnly) Scans the classpath for matching files, and calls any match processors 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 classpath,
                        String[] whitelistedPaths,
                        String[] blacklistedPaths)

Method Detail

addFilePathMatcher

public void addFilePathMatcher(RecursiveScanner.FilePathMatcher filePathMatcher)

scan

public void scan(boolean scanTimestampsOnly)

Scans the classpath for matching files, and calls any match processors if a match is identified. This method should be called after all required match processors have been added. This method should be called before any "get" methods (e.g. getSubclassesOf()).

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.