Class FileSystemWatcher
- java.lang.Object
- org.springframework.boot.devtools.filewatch.FileSystemWatcher
public class FileSystemWatcher extends Object
Watches specific folders for file changes.- Since:
- 1.3.0
- See Also:
FileChangeListener
Constructor Summary
Constructors Constructor Description FileSystemWatcher()
Create a newFileSystemWatcher
instance.FileSystemWatcher(boolean daemon, Duration pollInterval, Duration quietPeriod)
Create a newFileSystemWatcher
instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(FileChangeListener fileChangeListener)
Add listener for file change events.void
addSourceFolder(File folder)
Add a source folder to monitor.void
addSourceFolders(Iterable<File> folders)
Add source folders to monitor.void
setTriggerFilter(FileFilter triggerFilter)
Set an optionalFileFilter
used to limit the files that trigger a change.void
start()
Start monitoring the source folder for changes.void
stop()
Stop monitoring the source folders.
Constructor Detail
FileSystemWatcher
public FileSystemWatcher()
Create a newFileSystemWatcher
instance.
FileSystemWatcher
public FileSystemWatcher(boolean daemon, Duration pollInterval, Duration quietPeriod)
Create a newFileSystemWatcher
instance.- Parameters:
daemon
- if a daemon thread used to monitor changespollInterval
- the amount of time to wait between checking for changesquietPeriod
- the amount of time required after a change has been detected to ensure that updates have completed
Method Detail
addListener
public void addListener(FileChangeListener fileChangeListener)
Add listener for file change events. Cannot be called after the watcher has beenstarted
.- Parameters:
fileChangeListener
- the listener to add
addSourceFolders
public void addSourceFolders(Iterable<File> folders)
Add source folders to monitor. Cannot be called after the watcher has beenstarted
.- Parameters:
folders
- the folders to monitor
addSourceFolder
public void addSourceFolder(File folder)
Add a source folder to monitor. Cannot be called after the watcher has beenstarted
.- Parameters:
folder
- the folder to monitor
setTriggerFilter
public void setTriggerFilter(FileFilter triggerFilter)
Set an optionalFileFilter
used to limit the files that trigger a change.- Parameters:
triggerFilter
- a trigger filter or null
start
public void start()
Start monitoring the source folder for changes.
stop
public void stop()
Stop monitoring the source folders.