public class Scanner extends AbstractLifeCycle
Modifier and Type | Class and Description |
---|---|
static interface |
Scanner.BulkListener |
static interface |
Scanner.DiscreteListener |
static interface |
Scanner.Listener
Listener
Marker for notifications re file changes.
|
static class |
Scanner.Notification |
static interface |
Scanner.ScanCycleListener
Listener that notifies when a scan has started and when it has ended.
|
static interface |
Scanner.ScanListener |
AbstractLifeCycle.AbstractLifeCycleListener
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_SCAN_DEPTH
When walking a directory, a depth of 1 ensures that
the directory's descendants are visited, not just the
directory itself (as a file).
|
static int |
MAX_SCAN_DEPTH |
Constructor and Description |
---|
Scanner() |
Modifier and Type | Method and Description |
---|---|
IncludeExcludeSet<PathMatcher,Path> |
addDirectory(Path p)
Add a directory to be scanned.
|
void |
addFile(Path p)
Add a file to be scanned.
|
void |
addListener(Scanner.Listener listener)
Add an added/removed/changed listener
|
void |
addScanDir(File dir)
Deprecated.
|
void |
doStart()
Start the scanning action.
|
void |
doStop()
Stop the scanning.
|
boolean |
exists(String path) |
FilenameFilter |
getFilenameFilter()
Deprecated.
|
boolean |
getRecursive()
Deprecated.
|
boolean |
getReportDirs() |
boolean |
getReportExistingFilesOnStartup() |
int |
getScanDepth()
Get the scanDepth.
|
List<File> |
getScanDirs()
Deprecated.
|
int |
getScanInterval()
Get the scan interval
|
Set<Path> |
getScannables() |
Timer |
newTimer() |
TimerTask |
newTimerTask() |
void |
removeListener(Scanner.Listener listener)
Remove a registered listener
|
void |
reset()
Clear the list of scannables.
|
void |
scan()
Perform a pass of the scanner and report changes
|
void |
scanFiles()
Scan all of the given paths.
|
void |
schedule() |
void |
setFilenameFilter(FilenameFilter filter)
Deprecated.
|
void |
setRecursive(boolean recursive)
Deprecated.
|
void |
setReportDirs(boolean dirs)
Set if found directories should be reported.
|
void |
setReportExistingFilesOnStartup(boolean reportExisting)
Whether or not an initial scan will report all files as being
added.
|
void |
setScanDepth(int scanDepth)
Set the scanDepth.
|
void |
setScanDirs(List<File> dirs) |
void |
setScanInterval(int scanInterval)
Set the scan interval
|
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop, toString
public static final int DEFAULT_SCAN_DEPTH
Visitor#preVisitDirectory
,
Constant Field Valuespublic static final int MAX_SCAN_DEPTH
public int getScanInterval()
public void setScanInterval(int scanInterval)
scanInterval
- pause between scans in seconds, or 0 for no scan after the initial scan.@Deprecated public void addScanDir(File dir)
public void addFile(Path p) throws IOException
p
- the Path of the file to scan.IOException
public IncludeExcludeSet<PathMatcher,Path> addDirectory(Path p) throws IOException
p
- the directory to scan.IOException
@Deprecated public List<File> getScanDirs()
@Deprecated public void setRecursive(boolean recursive)
recursive
- True if scanning is recursivesetScanDepth(int)
@Deprecated public boolean getRecursive()
getScanDepth()
public int getScanDepth()
public void setScanDepth(int scanDepth)
scanDepth
- the scanDepth to set@Deprecated public void setFilenameFilter(FilenameFilter filter)
filter
- the filename filter to use@Deprecated public FilenameFilter getFilenameFilter()
public void setReportExistingFilesOnStartup(boolean reportExisting)
reportExisting
- if true, all files found on initial scan will be
reported as being added, otherwise notpublic boolean getReportExistingFilesOnStartup()
public void setReportDirs(boolean dirs)
dirs
- true to report directory changes as wellpublic boolean getReportDirs()
public void addListener(Scanner.Listener listener)
listener
- the listener to addpublic void removeListener(Scanner.Listener listener)
listener
- the Listener to be removedpublic void doStart()
public TimerTask newTimerTask()
public Timer newTimer()
public void schedule()
public void doStop()
public void reset()
public boolean exists(String path)
path
- tests if the path existspublic void scan()
public void scanFiles()
Copyright © 2010 - 2020 Adobe. All Rights Reserved