|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.jetty.util.Scanner
public class Scanner
Scanner Utility for scanning a directory for added, removed and changed files and reporting these events via registered Listeners. TODO AbstractLifeCycle
Nested Class Summary | |
---|---|
static interface |
Scanner.BulkListener
|
static interface |
Scanner.DiscreteListener
|
static interface |
Scanner.Listener
Listener Marker for notifications re file changes. |
Constructor Summary | |
---|---|
Scanner()
|
Method Summary | |
---|---|
void |
addListener(Scanner.Listener listener)
Add an added/removed/changed listener |
java.io.FilenameFilter |
getFilenameFilter()
Get any filter applied to files in the scan dir. |
boolean |
getRecursive()
|
boolean |
getReportDirs()
|
boolean |
getReportExistingFilesOnStartup()
|
int |
getScanDepth()
Get the scanDepth. |
java.io.File |
getScanDir()
Deprecated. use getScanDirs() instead |
java.util.List<java.io.File> |
getScanDirs()
|
int |
getScanInterval()
Get the scan interval |
java.util.Timer |
newTimer()
|
java.util.TimerTask |
newTimerTask()
|
void |
removeListener(Scanner.Listener listener)
Remove a registered listener |
void |
reportDifferences(java.util.Map<java.lang.String,java.lang.Long> currentScan,
java.util.Map<java.lang.String,java.lang.Long> oldScan)
Report the adds/changes/removes to the registered listeners |
void |
scan()
Perform a pass of the scanner and report changes |
void |
scanFiles()
Recursively scan all files in the designated directories. |
void |
schedule()
|
void |
setFilenameFilter(java.io.FilenameFilter filter)
Apply a filter to files found in the scan directory. |
void |
setRecursive(boolean recursive)
|
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 |
setScanDir(java.io.File dir)
Deprecated. use setScanDirs(List dirs) instead |
void |
setScanDirs(java.util.List<java.io.File> dirs)
|
void |
setScanInterval(int scanInterval)
Set the scan interval |
void |
start()
Start the scanning action. |
void |
stop()
Stop the scanning. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Scanner()
Method Detail |
---|
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 setScanDir(java.io.File dir)
dir
- @Deprecated public java.io.File getScanDir()
getScanDirs()
being scanned)public void setScanDirs(java.util.List<java.io.File> dirs)
public java.util.List<java.io.File> getScanDirs()
public void setRecursive(boolean recursive)
recursive
- True if scanning is recursive#setScanDepth()
public boolean getRecursive()
getScanDepth()
public int getScanDepth()
public void setScanDepth(int scanDepth)
scanDepth
- the scanDepth to setpublic void setFilenameFilter(java.io.FilenameFilter filter)
filter
- public java.io.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
- public boolean getReportDirs()
public void addListener(Scanner.Listener listener)
listener
- public void removeListener(Scanner.Listener listener)
listener
- the Listener to be removedpublic void start()
public java.util.TimerTask newTimerTask()
public java.util.Timer newTimer()
public void schedule()
public void stop()
public void scan()
public void scanFiles()
public void reportDifferences(java.util.Map<java.lang.String,java.lang.Long> currentScan, java.util.Map<java.lang.String,java.lang.Long> oldScan)
currentScan
- the info from the most recent passoldScan
- info from the previous pass
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |