Make sure to have a dedicated interface, to allow for future additions without breaking binary compatibility

Author: DavyLandman

src/main/java/engineering/swat/watch/ActiveWatch.java

@@ -0,0 +1,12 @@
+package engineering.swat.watch;
+
+import java.io.Closeable;
+
+/**
+ * <p>Marker interface for an active watch, in the future might get properties you can inspect.</p>
+ *
+ * <p>For now, make sure to close the watch when not interested in new events</p>
+ */
+public interface ActiveWatch extends Closeable {
+
+}

src/main/java/engineering/swat/watch/Watcher.java

@@ -1,6 +1,5 @@
 package engineering.swat.watch;
 
-import java.io.Closeable;
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.LinkOption;
@@ -96,7 +95,7 @@ public Watcher withExecutor(Executor callbackHandler) {
      * @throws IOException in case the starting of the watcher caused an underlying IO exception
      * @throws IllegalStateException the watchers is not configured correctly (for example, missing {@link #onEvent(Consumer)}, or a watcher is started twice)
      */
-    public Closeable start() throws IOException {
+    public ActiveWatch start() throws IOException {
         if (this.eventHandler == NULL_HANDLER) {
             throw new IllegalStateException("There is no onEvent handler defined");
         }

src/main/java/engineering/swat/watch/impl/jdk/JDKDirectoryWatcher.java

@@ -1,4 +1,4 @@
-package engineering.swat.watch.impl;
+package engineering.swat.watch.impl.jdk;
 
 import java.io.Closeable;
 import java.io.IOException;
@@ -13,9 +13,12 @@
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
+import engineering.swat.watch.ActiveWatch;
 import engineering.swat.watch.WatchEvent;
+import engineering.swat.watch.impl.util.BundledSubscription;
+import engineering.swat.watch.impl.util.SubscriptionKey;
 
-public class JDKDirectoryWatcher implements Closeable {
+public class JDKDirectoryWatcher implements ActiveWatch {
     private final Logger logger = LogManager.getLogger();
     private final Path directory;
     private final Executor exec;
@@ -95,7 +98,7 @@ else if (ev.kind() == StandardWatchEventKinds.OVERFLOW) {
     @Override
     public synchronized void close() throws IOException {
         if (activeWatch != null) {
-            logger.debug("Closing watch for: {}", this.directory);
+            logger.trace("Closing watch for: {}", this.directory);
             activeWatch.close();
         }
     }

src/main/java/engineering/swat/watch/impl/jdk/JDKFileWatcher.java

@@ -1,4 +1,4 @@
-package engineering.swat.watch.impl;
+package engineering.swat.watch.impl.jdk;
 
 import java.io.Closeable;
 import java.io.IOException;
@@ -10,14 +10,15 @@
 import org.apache.logging.log4j.Logger;
 import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
 
+import engineering.swat.watch.ActiveWatch;
 import engineering.swat.watch.WatchEvent;
 
 /**
  * It's not possible to monitor a single file (or directory), so we have to find a directory watcher, and connect to that
  *
  * Note that you should take care to call start only once.
  */
-public class JDKFileWatcher implements Closeable {
+public class JDKFileWatcher implements ActiveWatch {
     private final Logger logger = LogManager.getLogger();
     private final Path file;
     private final Path fileName;

src/main/java/engineering/swat/watch/impl/jdk/JDKRecursiveDirectoryWatcher.java

@@ -22,9 +22,10 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
+import engineering.swat.watch.ActiveWatch;
 import engineering.swat.watch.WatchEvent;
 
-public class JDKRecursiveDirectoryWatcher implements Closeable {
+public class JDKRecursiveDirectoryWatcher implements ActiveWatch {
     private final Logger logger = LogManager.getLogger();
     private final Path root;
     private final Executor exec;