Rework PathUtils/PathPredicates

Author: ComputerDaddyGuy

CHANGELOG.md

@@ -11,6 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - New path predicates: `hasParentMatching`, `hasAncestorMatching`, `hasDirectChildMatching`, `hasDescendantMatching`, `hasSiblingMatching`
 
+### Changed
+- `PathUtils` removed, `PathPredicates`rework
+
 ---
 ## [0.0.4] - 2025-09-27
 

README.md

@@ -178,13 +178,14 @@ child_limit_static/
 Or you can also set a limitation function, to dynamically choose the number of children displayed in each directory.
 It avoids cluttering the whole console with known large folders (e.g. `node_modules`) but continue to pretty print normally other folders.
 
-Use the `ChildLimitBuilder` and `PathPredicates` classes to help you build the limit function that fits your needs..
+Use the `ChildLimitBuilder` and `PathPredicates` classes to help you build the limit function that fits your needs.
 
 ```java
 // Example: ChildLimitDynamic.java
+var isNodeModulePredicate = PathPredicates.builder().hasName("node_modules").build();
 var childLimit = ChildLimitBuilder.builder()
 	.defaultLimit(ChildLimitBuilder.UNLIMITED)
-	.limit(PathPredicates.hasName("node_modules"), 0)
+	.limit(isNodeModulePredicate, 0)
 	.build();
 var prettyPrinter = FileTreePrettyPrinter.builder()
     .customizeOptions(options -> options.withChildLimit(childLimit)) 
@@ -278,12 +279,13 @@ Files and directories can be selectively included or excluded using a custom `Pr
 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.
 
-The `PathPredicates` class provides several ready-to-use `Predicate<Path>` implementations for common cases, as well as a builder for creating more advanced predicates.
+The `PathPredicates` class provides several ready-to-use methods for creating common predicates, as well as a builder for creating more advanced predicates.
 
 ```java
 // Example: Filtering.java
+var hasJavaExtensionPredicate = PathPredicates.builder().hasExtension("java").build();
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.filter(PathPredicates.hasExtension("java")))
+    .customizeOptions(options -> options.filter(hasJavaExtensionPredicate))
     .build();
 ```
 ```
@@ -308,16 +310,16 @@ If the function returns `null`, nothing is added.
 ```java
 // Example: LineExtension.java
 Function<Path, String> lineExtension = path -> {
-	if (PathUtils.isDirectory(path) && PathUtils.hasName(path, "api")) {
+	if (PathPredicates.isDirectory(path) && PathPredicates.hasName(path, "api")) {
 		return "\t\t\t// All API code: controllers, etc.";
 	}
-	if (PathUtils.isDirectory(path) && PathUtils.hasName(path, "domain")) {
+	if (PathPredicates.isDirectory(path) && PathPredicates.hasName(path, "domain")) {
 		return "\t\t\t// All domain code: value objects, etc.";
 	}
-	if (PathUtils.isDirectory(path) && PathUtils.hasName(path, "infra")) {
+	if (PathPredicates.isDirectory(path) && PathPredicates.hasName(path, "infra")) {
 		return "\t\t\t// All infra code: database, email service, etc.";
 	}
-	if (PathUtils.isFile(path) && PathUtils.hasName(path, "application.properties")) {
+	if (PathPredicates.isFile(path) && PathPredicates.hasName(path, "application.properties")) {
 		return "\t// Config file";
 	}
 	return null;

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

@@ -7,9 +7,10 @@
 public class ChildLimitDynamic {
 
 	public static void main(String[] args) {
+		var isNodeModulePredicate = PathPredicates.builder().hasName("node_modules").build();
 		var childLimit = ChildLimitBuilder.builder()
 			.defaultLimit(ChildLimitBuilder.UNLIMITED)
-			.limit(PathPredicates.hasName("node_modules"), 0)
+			.limit(isNodeModulePredicate, 0)
 			.build();
 		var prettyPrinter = FileTreePrettyPrinter.builder()
 			.customizeOptions(options -> options.withChildLimit(childLimit))

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

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

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

@@ -1,24 +1,24 @@
 package io.github.computerdaddyguy.jfiletreeprettyprinter.example;
 
 import io.github.computerdaddyguy.jfiletreeprettyprinter.FileTreePrettyPrinter;
-import io.github.computerdaddyguy.jfiletreeprettyprinter.PathUtils;
+import io.github.computerdaddyguy.jfiletreeprettyprinter.PathPredicates;
 import java.nio.file.Path;
 import java.util.function.Function;
 
 public class LineExtension {
 
 	public static void main(String[] args) {
 		Function<Path, String> lineExtension = path -> {
-			if (PathUtils.isDirectory(path) && PathUtils.hasName(path, "api")) {
+			if (PathPredicates.isDirectory(path) && PathPredicates.hasName(path, "api")) {
 				return "\t\t\t// All API code: controllers, etc.";
 			}
-			if (PathUtils.isDirectory(path) && PathUtils.hasName(path, "domain")) {
+			if (PathPredicates.isDirectory(path) && PathPredicates.hasName(path, "domain")) {
 				return "\t\t\t// All domain code: value objects, etc.";
 			}
-			if (PathUtils.isDirectory(path) && PathUtils.hasName(path, "infra")) {
+			if (PathPredicates.isDirectory(path) && PathPredicates.hasName(path, "infra")) {
 				return "\t\t\t// All infra code: database, email service, etc.";
 			}
-			if (PathUtils.isFile(path) && PathUtils.hasName(path, "application.properties")) {
+			if (PathPredicates.isFile(path) && PathPredicates.hasName(path, "application.properties")) {
 				return "\t// Config file";
 			}
 			return null;

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

@@ -26,8 +26,8 @@
  * <pre>{@code
  * var childLimit = ChildLimitBuilder.builder()
  *     .defaultLimit(ChildLimit.UNLIMITED)   // unlimited unless specified
- *     .limit(path -> PathUtils.hasName("bigDir"), 10)  // max 10 children in "bigDir"
- *     .limit(path -> PathUtils.hasName("emptyDir"), 0) // disallow children in "emptyDir"
+ *     .limit(path -> PathPredicates.hasName(path, "bigDir"), 10)  // max 10 children in "bigDir"
+ *     .limit(path -> PathPredicates.hasName(path, "emptyDir"), 0) // disallow children in "emptyDir"
  *     .build();
  *
  * }</pre>

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

@@ -86,7 +86,8 @@ public PathPredicateBuilder fileTest(Predicate<File> predicate) {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder hasName(String name) {
-		return pathTest(PathPredicates.hasName(name));
+		Objects.requireNonNull(name, "name is null");
+		return pathTest(path -> PathPredicates.hasName(path, name));
 	}
 
 	/**
@@ -98,7 +99,8 @@ public PathPredicateBuilder hasName(String name) {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder hasNameIgnoreCase(String name) {
-		return pathTest(PathPredicates.hasNameIgnoreCase(name));
+		Objects.requireNonNull(name, "name is null");
+		return pathTest(path -> PathPredicates.hasNameIgnoreCase(path, name));
 	}
 
 	/**
@@ -109,7 +111,8 @@ public PathPredicateBuilder hasNameIgnoreCase(String name) {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder hasNameMatching(Pattern pattern) {
-		return pathTest(PathPredicates.hasNameMatching(pattern));
+		Objects.requireNonNull(pattern, "pattern is null");
+		return pathTest(path -> PathPredicates.hasNameMatching(path, pattern));
 	}
 
 	/**
@@ -120,7 +123,8 @@ public PathPredicateBuilder hasNameMatching(Pattern pattern) {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder hasNameEndingWith(String suffix) {
-		return pathTest(PathPredicates.hasNameEndingWith(suffix));
+		Objects.requireNonNull(suffix, "suffix is null");
+		return pathTest(path -> PathPredicates.hasNameEndingWith(path, suffix));
 	}
 
 	/**
@@ -135,7 +139,8 @@ public PathPredicateBuilder hasNameEndingWith(String suffix) {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder hasExtension(String extension) {
-		return pathTest(PathPredicates.hasExtension(extension));
+		Objects.requireNonNull(extension, "extension is null");
+		return pathTest(path -> PathPredicates.hasExtension(path, extension));
 	}
 
 	// ---------- Type ----------
@@ -146,7 +151,7 @@ public PathPredicateBuilder hasExtension(String extension) {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder isDirectory() {
-		return pathTest(PathPredicates.isDirectory());
+		return pathTest(path -> PathPredicates.isDirectory(path));
 	}
 
 	/**
@@ -155,7 +160,7 @@ public PathPredicateBuilder isDirectory() {
 	 * @return this builder for chaining
 	 */
 	public PathPredicateBuilder isFile() {
-		return pathTest(PathPredicates.isFile());
+		return pathTest(path -> PathPredicates.isFile(path));
 	}
 
 	// ---------- Hierarchy ----------
@@ -170,7 +175,8 @@ public PathPredicateBuilder isFile() {
 	 * @see PathPredicates#hasParentMatching(Predicate)
 	 */
 	public PathPredicateBuilder hasParentMatching(Predicate<Path> parentPredicate) {
-		return pathTest(PathPredicates.hasParentMatching(parentPredicate));
+		Objects.requireNonNull(parentPredicate, "parentPredicate is null");
+		return pathTest(path -> PathPredicates.hasParentMatching(path, parentPredicate));
 	}
 
 	/**
@@ -186,7 +192,8 @@ public PathPredicateBuilder hasParentMatching(Predicate<Path> parentPredicate) {
 	 * @see PathPredicates#hasAncestorMatching(Predicate)
 	 */
 	public PathPredicateBuilder hasAncestorMatching(Predicate<Path> ancestorPredicate) {
-		return pathTest(PathPredicates.hasAncestorMatching(ancestorPredicate));
+		Objects.requireNonNull(ancestorPredicate, "ancestorPredicate is null");
+		return pathTest(path -> PathPredicates.hasAncestorMatching(path, ancestorPredicate));
 	}
 
 	/**
@@ -202,7 +209,8 @@ public PathPredicateBuilder hasAncestorMatching(Predicate<Path> ancestorPredicat
 	 * @see PathPredicates#hasDirectChildMatching(Predicate)
 	 */
 	public PathPredicateBuilder hasDirectChildMatching(Predicate<Path> childPredicate) {
-		return pathTest(PathPredicates.hasDirectChildMatching(childPredicate));
+		Objects.requireNonNull(childPredicate, "childPredicate is null");
+		return pathTest(path -> PathPredicates.hasDirectChildMatching(path, childPredicate));
 	}
 
 	/**
@@ -218,7 +226,8 @@ public PathPredicateBuilder hasDirectChildMatching(Predicate<Path> childPredicat
 	 * @see PathPredicates#hasDescendantMatching(Predicate)
 	 */
 	public PathPredicateBuilder hasDescendantMatching(Predicate<Path> descendantPredicate) {
-		return pathTest(PathPredicates.hasDescendantMatching(descendantPredicate));
+		Objects.requireNonNull(descendantPredicate, "descendantPredicate is null");
+		return pathTest(path -> PathPredicates.hasDescendantMatching(path, descendantPredicate));
 	}
 
 	/**
@@ -234,7 +243,8 @@ public PathPredicateBuilder hasDescendantMatching(Predicate<Path> descendantPred
 	 * @see PathPredicates#hasSiblingMatching(Predicate)
 	 */
 	public PathPredicateBuilder hasSiblingMatching(Predicate<Path> siblingPredicate) {
-		return pathTest(PathPredicates.hasSiblingMatching(siblingPredicate));
+		Objects.requireNonNull(siblingPredicate, "siblingPredicate is null");
+		return pathTest(path -> PathPredicates.hasSiblingMatching(path, siblingPredicate));
 	}
 
 }