org.neo4j.io.fs.watcher

Class DefaultFileSystemWatcher

java.lang.Object

org.neo4j.io.fs.watcher.DefaultFileSystemWatcher

All Implemented Interfaces:

Closeable, AutoCloseable, FileWatcher

public class DefaultFileSystemWatcher
extends Object
implements FileWatcher

File watcher that monitors registered directories state using possibilities provided by WatchService. Safe to be used from multiple threads

Field Summary

Fields inherited from interface org.neo4j.io.fs.watcher.FileWatcher

SILENT_WATCHER

Constructor Summary

Constructors

Constructor and Description
DefaultFileSystemWatcher(WatchService watchService)

Method Summary

Modifier and Type	Method and Description
void	addFileWatchEventListener(FileWatchEventListener listener) Register listener to receive updates about registered resources.
void	close()
void	removeFileWatchEventListener(FileWatchEventListener listener) Remove listener from a list of updates receivers.
void	startWatching() Start monitoring of registered directories.
void	stopWatching() Stop monitoring of registered directories
WatchedResource	watch(File file) Register provided directory in list of resources that we would like to watch and receive status modification updates

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultFileSystemWatcher

public DefaultFileSystemWatcher(WatchService watchService)

Method Detail

watch

public WatchedResource watch(File file)
                      throws IOException

Description copied from interface: FileWatcher

Register provided directory in list of resources that we would like to watch and receive status modification updates

Specified by:

watch in interface FileWatcher

Parameters:

file - directory to be monitored for updates

Returns:

Throws:

IOException

startWatching

public void startWatching()
                   throws InterruptedException

Description copied from interface: FileWatcher

Start monitoring of registered directories. This method we will wait for notification about registered resources, meaning that it will block thread where it was called. If it is desired to start file watching as background task - watcher should be started in separate thread. Watching can be stopped by calling FileWatcher.stopWatching().

Specified by:

startWatching in interface FileWatcher

Throws:

InterruptedException - when interrupted while waiting for update notification to come

stopWatching

public void stopWatching()

Description copied from interface: FileWatcher

Stop monitoring of registered directories

Specified by:

stopWatching in interface FileWatcher

addFileWatchEventListener

public void addFileWatchEventListener(FileWatchEventListener listener)

Description copied from interface: FileWatcher

Register listener to receive updates about registered resources.

Specified by:

addFileWatchEventListener in interface FileWatcher

Parameters:

listener - listener to register

removeFileWatchEventListener

public void removeFileWatchEventListener(FileWatchEventListener listener)

Description copied from interface: FileWatcher

Remove listener from a list of updates receivers.

Specified by:

removeFileWatchEventListener in interface FileWatcher

Parameters:

listener - listener to remove

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException