io.methvin.watcher

Class DirectoryWatcher

java.lang.Object

io.methvin.watcher.DirectoryWatcher

public class DirectoryWatcher
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DirectoryWatcher.Builder A builder for a DirectoryWatcher.

Constructor Summary

Constructors

Constructor and Description
DirectoryWatcher(java.util.List<java.nio.file.Path> paths, DirectoryChangeListener listener, java.nio.file.WatchService watchService, FileHasher fileHasher, FileTreeVisitor fileTreeVisitor, org.slf4j.Logger logger)

Method Summary

Modifier and Type	Method and Description
static DirectoryWatcher.Builder	builder() Get a new builder for a DirectoryWatcher.
void	close()
DirectoryChangeListener	getListener()
boolean	isClosed()
java.util.Map<java.nio.file.Path,FileHash>	pathHashes()
void	watch() Watch for changes; block until the listener stops listening or the watcher is closed.
java.util.concurrent.CompletableFuture<java.lang.Void>	watchAsync() Asynchronously watch the directories using ForkJoinPool.commonPool() as the executor
java.util.concurrent.CompletableFuture<java.lang.Void>	watchAsync(java.util.concurrent.Executor executor) Start watching for changes asynchronously.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryWatcher

public DirectoryWatcher(java.util.List<java.nio.file.Path> paths,
                        DirectoryChangeListener listener,
                        java.nio.file.WatchService watchService,
                        FileHasher fileHasher,
                        FileTreeVisitor fileTreeVisitor,
                        org.slf4j.Logger logger)

Method Detail

builder

public static DirectoryWatcher.Builder builder()

Get a new builder for a DirectoryWatcher.

watchAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> watchAsync()

Asynchronously watch the directories using ForkJoinPool.commonPool() as the executor

watchAsync

public java.util.concurrent.CompletableFuture<java.lang.Void> watchAsync(java.util.concurrent.Executor executor)

Start watching for changes asynchronously.

The future completes when the listener stops listening or the watcher is closed.

This method will block until the watcher is initialized and successfully watching.

Parameters:

executor - the executor to use to watch asynchronously

watch

public void watch()

Watch for changes; block until the listener stops listening or the watcher is closed.

Throws:

java.lang.IllegalStateException - if the directory watcher is closed when watch() is called.

pathHashes

public java.util.Map<java.nio.file.Path,FileHash> pathHashes()

getListener

public DirectoryChangeListener getListener()

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

isClosed

public boolean isClosed()