org.neo4j.io.fs.watcher

Interface FileWatcher

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

DefaultFileSystemWatcher, RestartableFileSystemWatcher, SilentFileWatcher

public interface FileWatcher
extends Closeable

Watcher that allows receive notification about files modifications/removal for particular underlying file system. To be able to get notification users need to register resource they are interested in using watch(File) method call and add by adding listner to be able to receive status updates.

See Also:

WatchService

Field Summary

Fields

Modifier and Type	Field and Description
static FileWatcher	SILENT_WATCHER

Method Summary

Modifier and Type	Method and Description
void	addFileWatchEventListener(FileWatchEventListener listener) Register listener to receive updates about registered resources.
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 interface java.io.Closeable

close

Field Detail

SILENT_WATCHER

static final FileWatcher SILENT_WATCHER

Method Detail

watch

WatchedResource watch(File file)
               throws IOException

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

Parameters:

file - directory to be monitored for updates

Returns:

Throws:

IOException

addFileWatchEventListener

void addFileWatchEventListener(FileWatchEventListener listener)

Register listener to receive updates about registered resources.

Parameters:

listener - listener to register

removeFileWatchEventListener

void removeFileWatchEventListener(FileWatchEventListener listener)

Remove listener from a list of updates receivers.

Parameters:

listener - listener to remove

stopWatching

void stopWatching()

Stop monitoring of registered directories

startWatching

void startWatching()
            throws InterruptedException

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 stopWatching().

Throws:

InterruptedException - when interrupted while waiting for update notification to come