Rename DIRTY to DIFF

Author: sungshik

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

@@ -66,8 +66,8 @@ public enum Approximation {
      *
      * <p>
      * This approach is relatively cheap in terms of memory usage (cf.
-     * {@link #DIRTY}), but it results in a large over/underapproximation of the
-     * actual events (cf. DIRTY).
+     * {@link #DIFF}), but it results in a large over/underapproximation of the
+     * actual events (cf. DIFF).
      */
     ALL,
 
@@ -76,7 +76,8 @@ public enum Approximation {
      * <p>
      * Synthetic events of kinds {@link WatchEvent.Kind#CREATED},
      * {@link WatchEvent.Kind#MODIFIED}, and {@link WatchEvent.Kind#DELETED} are
-     * issued for dirty regular files/directories in the scope of the watch, as
+     * issued for regular files/directories in the scope of the watch, when
+     * their current versions are different from their previous versions, as
      * determined using <i>last-modified-times</i>. Specifically, when an
      * overflow event happens:
      *
@@ -103,5 +104,5 @@ public enum Approximation {
      * but it is relatively expensive in terms of memory usage (cf. ALL), as the
      * watch needs to keep track of last-modified-times.
      */
-    DIRTY
+    DIFF
 }

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

@@ -233,7 +233,7 @@ private BiConsumer<EventHandlingWatch, WatchEvent> applyApproximateOnOverflow()
                 return eventHandler;
             case ALL:
                 return eventHandler.andThen(new MemorylessRescanner(executor));
-            case DIRTY:
+            case DIFF:
                 return eventHandler.andThen(new IndexingRescanner(executor, path, scope));
             default:
                 throw new UnsupportedOperationException("No event handler has been defined yet for this overflow policy");

src/test/java/engineering/swat/watch/SingleDirectoryTests.java

@@ -179,7 +179,7 @@ void indexingRescanOnOverflow() throws IOException, InterruptedException {
         var nDeleted = new AtomicInteger();
 
         var watchConfig = Watcher.watch(directory, WatchScope.PATH_AND_CHILDREN)
-            .onOverflow(Approximation.DIRTY)
+            .onOverflow(Approximation.DIFF)
             .on(e -> {
                 var kind = e.getKind();
                 if (kind != OVERFLOW) {

src/test/java/engineering/swat/watch/TortureTests.java

@@ -145,7 +145,7 @@ Set<Path> stop() throws InterruptedException {
     private static final int THREADS = 4;
 
     @ParameterizedTest
-    @EnumSource(names = { "ALL", "DIRTY" })
+    @EnumSource(names = { "ALL", "DIFF" })
     void pressureOnFSShouldNotMissNewFilesAnything(Approximation whichFiles) throws InterruptedException, IOException {
         final var root = testDir.getTestDirectory();
         var pool = Executors.newFixedThreadPool(Runtime.getRuntime().availableProcessors() * 4);
@@ -268,7 +268,7 @@ void manyRegistrationsForSamePath() throws InterruptedException, IOException {
     }
 
     static Stream<Approximation> manyRegisterAndUnregisterSameTimeSource() {
-        Approximation[] values = { Approximation.ALL, Approximation.DIRTY };
+        Approximation[] values = { Approximation.ALL, Approximation.DIFF };
         return TestHelper.streamOf(values, 5);
     }
 
@@ -342,7 +342,7 @@ void manyRegisterAndUnregisterSameTime(Approximation whichFiles) throws Interrup
     }
 
     @ParameterizedTest
-    @EnumSource(names = { "ALL", "DIRTY" })
+    @EnumSource(names = { "ALL", "DIFF" })
     //Deletes can race the filesystem, so you might miss a few files in a dir, if that dir is already deleted
     @EnabledIfEnvironmentVariable(named="TORTURE_DELETE", matches="true")
     void pressureOnFSShouldNotMissDeletes(Approximation whichFiles) throws InterruptedException, IOException {