Improved overflow support

[sungshik]

Content

This is the main PR to address #12. It consists of the following auxiliary PRs:

• Improved overflow support: Scaffolding #18
• Improved overflow support: Internal EventHandlingWatch interface #19
• Improved overflow support: Internal event handlers can dispatch new events #21
• Improved overflow support: Overflow auto-handling for directory watches (non-recursive) #24
• Improved overflow support: Overflow auto-handling for file watches #25
• Improved overflow support: Indexing rescanner #26
• Improved overflow support: Fix detection of DELETED events in IndexingRescanner #28
• Improved overflow support: Recursive directory watches #27
• Improved overflow support: Parameterized torture tests #29
• Improved overflow support: Update README #30

Tasks

Features:

• Test this situation (i.e., when watching a single file: overflow in parent directory triggers overflow for file)
• Make it possible to distinguish original events from synthetic events (comment)? -- Not needed for now

Code quality:

• Reduce visibility of JDK... (moved to a separate issue: Reduce visibility of JDK... classes #22)
• Update torture tests to test both MemorylessRescanner vs IndexingRescanner (comment 1, comment 2)
• Take more advantage of filtering capability (e.g., conceptually, JDKFileWatch is just a JDKDirectoryWatch with a particular filter) (moved to separate issue: Use filter in the implementation of JDKFileWatch #31)

Performance:

• Make the index of IndexingRescanner more hierarchical to improve performance (time and space) (comment)
• Debounce overflow handling (comment) (moved to separate issue: Debounce overflow handler #32)

[codecov]

Codecov Report

Attention: Patch coverage is 80.93842% with 65 lines in your changes missing coverage. Please review.

Project coverage is 80.7%. Comparing base (e23a194) to head (3afc76f).
Report is 138 commits behind head on main.

Files with missing lines	Patch %	Lines
...ineering/swat/watch/impl/jdk/JDKFileTreeWatch.java	74.7%	19 Missing and 10 partials ⚠️
...g/swat/watch/impl/overflows/IndexingRescanner.java	79.5%	12 Missing and 7 partials ⚠️
...ing/swat/watch/impl/overflows/BaseFileVisitor.java	64.7%	5 Missing and 1 partial ⚠️
src/main/java/engineering/swat/watch/Watcher.java	84.6%	2 Missing and 2 partials ⚠️
.../engineering/swat/watch/impl/jdk/JDKBaseWatch.java	82.3%	1 Missing and 2 partials ⚠️
.../engineering/swat/watch/impl/jdk/JDKFileWatch.java	88.2%	1 Missing and 1 partial ⚠️
...c/main/java/engineering/swat/watch/WatchEvent.java	87.5%	0 Missing and 1 partial ⚠️
...neering/swat/watch/impl/jdk/JDKDirectoryWatch.java	91.6%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@ Coverage Diff @@## main #20 +/- ##
=========================================
+ Coverage 80.0% 80.7% +0.7% - Complexity 88 131 +43 
=========================================
Files 11 16 +5 Lines 415 567 +152 Branches 41 64 +23 =========================================
+ Hits 332 458 +126 - Misses 57 69 +12 - Partials 26 40 +14 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[DavyLandman]

Yes, looks good, 2 small comments