summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/funcutils/FileUtils.java
diff options
context:
space:
mode:
authorBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 22:49:16 -0300
committerBenjamin J. Culkin <bjculkin@mix.wvu.edu>2017-10-11 22:49:16 -0300
commit8923edffdb36b790014ff47301e53f7ede93ea0d (patch)
treee1cff9168eb79110a8832249d208f2978f549a04 /base/src/main/java/bjc/utils/funcutils/FileUtils.java
parent946cab444bc301d8a7c756a1bab039558288de89 (diff)
Cleanup more
Diffstat (limited to 'base/src/main/java/bjc/utils/funcutils/FileUtils.java')
-rw-r--r--base/src/main/java/bjc/utils/funcutils/FileUtils.java31
1 files changed, 17 insertions, 14 deletions
diff --git a/base/src/main/java/bjc/utils/funcutils/FileUtils.java b/base/src/main/java/bjc/utils/funcutils/FileUtils.java
index 87199b1..6b897df 100644
--- a/base/src/main/java/bjc/utils/funcutils/FileUtils.java
+++ b/base/src/main/java/bjc/utils/funcutils/FileUtils.java
@@ -7,31 +7,34 @@ import java.nio.file.attribute.BasicFileAttributes;
import java.util.function.BiPredicate;
/**
- * Utilities for doing things with files
+ * Utilities for doing things with files.
*
* @author ben
- *
*/
public class FileUtils {
+ /*
+ * @NOTE
+ * If it becomes necessary, write another overload
+ * for this with all the buttons and knobs from
+ * walkFileTree.
+ */
/**
- * Traverse a directory recursively. This is a depth-first traversal
- *
+ * Traverse a directory recursively. This is a depth-first traversal.
*
* @param root
- * The directory to start the traversal at
+ * The directory to start the traversal at.
+ *
* @param predicate
- * The predicate to determine whether or not to traverse
- * a directory
+ * The predicate to determine whether or not to traverse
+ * a directory.
+ *
* @param action
- * The action to invoke upon each file in the directory.
- * Returning true means to continue the traversal,
- * returning false stops it
+ * The action to invoke upon each file in the directory. Returning
+ * true means to continue the traversal, returning false stops it.
+ *
* @throws IOException
- * if the walk throws an exception
+ * If the walk throws an exception.
*
- * TODO If it becomes necessary, write another overload
- * for this with all the buttons and knobs from
- * walkFileTree
*/
public static void traverseDirectory(final Path root, final BiPredicate<Path, BasicFileAttributes> predicate,
final BiPredicate<Path, BasicFileAttributes> action) throws IOException {