Rework filtering: moved to options

Author: ComputerDaddyGuy

CHANGELOG.md

@@ -6,7 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [0.0.4] - Unreleased
-- TODO
+
+### Changed
+- Filtering: moved to options
 
 
 ## [0.0.3] - 2025-09-21

README.md

@@ -273,9 +273,9 @@ The `PathPredicates` class provides several ready-to-use `Predicate<Path>` imple
 
 ```java
 // Example: Filtering.java
-var filter = PathPredicates.hasExtension("java");
-var tree = FileTreePrettyPrinter.createDefault()
-	.prettyPrint("src/example/resources/filtering", filter);
+var prettyPrinter = FileTreePrettyPrinter.builder()
+    .customizeOptions(options -> options.filter(PathPredicates.hasExtension("java")))
+    .build();
 ```
 ```
 filtering/

ROADMAP.md

@@ -28,6 +28,7 @@
 - [ ] Option: color
 - [ ] Refactor unit tests (custom assert?)
 - [ ] Jacoco coverage report
+- [ ] More `PathPredicates` functions!
 
 ## Abandoned
 These ideas will likely not been implemented because they do not align with JFileTreePrettyPrint vision:

src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/Filtering.java

@@ -6,9 +6,11 @@
 public class Filtering {
 
 	public static void main(String[] args) {
-		var filter = PathPredicates.hasExtension("java");
-		var prettyPrinter = FileTreePrettyPrinter.createDefault();
-		var tree = prettyPrinter.prettyPrint("src/example/resources/filtering", filter);
+		var prettyPrinter = FileTreePrettyPrinter.builder()
+			.customizeOptions(options -> options.filter(PathPredicates.hasExtension("java")))
+			.build();
+
+		var tree = prettyPrinter.prettyPrint("src/example/resources/filtering");
 		System.out.println(tree);
 	}
 

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/DefaultFileTreePrettyPrinter.java

@@ -4,9 +4,7 @@
 import io.github.computerdaddyguy.jfiletreeprettyprinter.scanner.PathToTreeScanner;
 import java.nio.file.Path;
 import java.util.Objects;
-import java.util.function.Predicate;
 import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
 
 @NullMarked
 class DefaultFileTreePrettyPrinter implements FileTreePrettyPrinter {
@@ -20,8 +18,8 @@ public DefaultFileTreePrettyPrinter(PathToTreeScanner scanner, TreeEntryRenderer
 	}
 
 	@Override
-	public String prettyPrint(Path path, @Nullable Predicate<Path> filter) {
-		var tree = scanner.scan(path, filter);
+	public String prettyPrint(Path path) {
+		var tree = scanner.scan(path);
 		return renderer.renderTree(tree);
 	}
 

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/FileTreePrettyPrinter.java

@@ -1,9 +1,7 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter;
 
 import java.nio.file.Path;
-import java.util.function.Predicate;
 import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
 
 /**
  * Pretty prints a file tree, and returns the result as a String.
@@ -20,34 +18,15 @@ public interface FileTreePrettyPrinter {
 	 * @param path		A directory or a file.
 	 * @param filter	Filter for paths to retain, <code>null</code> will retain all files. Applies only on children paths, not root path.
 	 */
-	String prettyPrint(Path path, @Nullable Predicate<Path> filter);
-
-	/**
-	 * Pretty prints the given path.
-	 * 
-	 * @param path	A directory or a file.
-	 */
-	default String prettyPrint(Path path) {
-		return prettyPrint(path, null);
-	}
+	String prettyPrint(Path path);
 
 	/**
 	 * Pretty prints the given path.
 	 * 
 	 * @param path	A directory or a file.
 	 */
 	default String prettyPrint(String path) {
-		return prettyPrint(path, null);
-	}
-
-	/**
-	 * Pretty prints the given path.
-	 * 
-	 * @param path		A directory or a file.
-	 * @param filter	Filter for paths to retain, <code>null</code> will retain all files. Applies only on children paths, not root path.
-	 */
-	default String prettyPrint(String path, @Nullable Predicate<Path> filter) {
-		return prettyPrint(Path.of(path), filter);
+		return prettyPrint(Path.of(path));
 	}
 
 	/**

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/PrettyPrintOptions.java

@@ -5,8 +5,10 @@
 import java.nio.file.Path;
 import java.util.Comparator;
 import java.util.Objects;
+import java.util.function.Predicate;
 import java.util.function.ToIntFunction;
 import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 @NullMarked
 public class PrettyPrintOptions implements ScanningOptions, RenderingOptions {
@@ -278,4 +280,28 @@ public PrettyPrintOptions sort(Comparator<Path> pathComparator) {
 		return this;
 	}
 
+	// ---------- Filtering ----------
+
+	@Nullable
+	private Predicate<Path> pathFilter = null;
+
+	@Override
+	@Nullable
+	public Predicate<Path> pathFilter() {
+		return pathFilter;
+	}
+
+	/**
+	 * Use a custom filter for retain only some files and/or directories.
+	 * 
+	 * Filtering is recursive by default: directory's contents will always be traversed.
+	 * However, if a directory does not match and none of its children match, the directory itself will not be displayed.
+	
+	 * @param filter	The filter, <code>null</code> to disable filtering
+	 */
+	public PrettyPrintOptions filter(Predicate<Path> filter) {
+		this.pathFilter = filter;
+		return this;
+	}
+
 }

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/scanner/DefaultPathToTreeScanner.java

@@ -31,8 +31,8 @@ public DefaultPathToTreeScanner(ScanningOptions options) {
 	}
 
 	@Override
-	public TreeEntry scan(Path fileOrDir, @Nullable Predicate<Path> filter) {
-		return handle(0, fileOrDir, filter);
+	public TreeEntry scan(Path fileOrDir) {
+		return handle(0, fileOrDir, options.pathFilter());
 	}
 
 	@Nullable

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/scanner/PathToTreeScanner.java

@@ -1,14 +1,12 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.scanner;
 
 import java.nio.file.Path;
-import java.util.function.Predicate;
 import org.jspecify.annotations.NullMarked;
-import org.jspecify.annotations.Nullable;
 
 @NullMarked
 public interface PathToTreeScanner {
 
-	TreeEntry scan(Path fileOrDir, @Nullable Predicate<Path> filter);
+	TreeEntry scan(Path fileOrDir);
 
 	/**
 	 * Creates a new path handler with given options.

src/main/java/io/github/computerdaddyguy/jfiletreeprettyprinter/scanner/ScanningOptions.java

@@ -2,8 +2,10 @@
 
 import java.nio.file.Path;
 import java.util.Comparator;
+import java.util.function.Predicate;
 import java.util.function.ToIntFunction;
 import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 @NullMarked
 public interface ScanningOptions {
@@ -14,4 +16,7 @@ public interface ScanningOptions {
 
 	Comparator<Path> pathComparator();
 
+	@Nullable
+	Predicate<Path> pathFilter();
+
 }