summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java
diff options
context:
space:
mode:
Diffstat (limited to 'base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java')
-rw-r--r--base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java15
1 files changed, 14 insertions, 1 deletions
diff --git a/base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java b/base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java
index db6c43b..b0dd162 100644
--- a/base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java
+++ b/base/src/main/java/bjc/utils/funcutils/FunctionalFileVisitor.java
@@ -7,13 +7,26 @@ import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.function.BiPredicate;
-/*
+/**
* Functional implementation of a file visitor.
+ *
+ * @author Ben Culkin
*/
final class FunctionalFileVisitor extends SimpleFileVisitor<Path> {
+ /* Our predicate to pick files. */
private final BiPredicate<Path, BasicFileAttributes> predicate;
+ /* Our action to aply to files. */
private final BiPredicate<Path, BasicFileAttributes> action;
+ /**
+ * Create a new file visitor, powered by functions.
+ *
+ * @param predicate
+ * The predicate to use to pick which files to traverse.
+ *
+ * @param action
+ * The function to execute on every file.
+ */
public FunctionalFileVisitor(final BiPredicate<Path, BasicFileAttributes> predicate,
final BiPredicate<Path, BasicFileAttributes> action) {
this.predicate = predicate;