Make example compile (i.e. supply a Path/File) and use depth first in…

…stead of breadth first. Reason: Depth first is more common for file traversal. RELNOTES=N/A ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=223782436
google · Dec 5, 2018 · 3dfee64 · 3dfee64
1 parent 920e72f
commit 3dfee64
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/android/guava/src/com/google/common/io/Files.java b/android/guava/src/com/google/common/io/Files.java
@@ -828,8 +828,9 @@ public String toString() {
    * a directory, no exception will be thrown and the returned {@link Iterable} will contain a
    * single element: that file.
    *
-   * <p>Example: {@code Files.fileTraverser().breadthFirst("/")} may return files with the following
-   * paths: {@code ["/", "/etc", "/home", "/usr", "/etc/config.txt", "/etc/fonts", ...]}
+   * <p>Example: {@code Files.fileTraverser().depthFirstPreOrder(new File("/"))} may return files
+   * with the following paths: {@code ["/", "/etc", "/etc/config.txt", "/etc/fonts", "/home",
+   * "/home/alice", ...]}
    *
    * @since 23.5
    */

diff --git a/guava/src/com/google/common/io/Files.java b/guava/src/com/google/common/io/Files.java
@@ -828,8 +828,9 @@ public String toString() {
    * a directory, no exception will be thrown and the returned {@link Iterable} will contain a
    * single element: that file.
    *
-   * <p>Example: {@code Files.fileTraverser().breadthFirst("/")} may return files with the following
-   * paths: {@code ["/", "/etc", "/home", "/usr", "/etc/config.txt", "/etc/fonts", ...]}
+   * <p>Example: {@code Files.fileTraverser().depthFirstPreOrder(new File("/"))} may return files
+   * with the following paths: {@code ["/", "/etc", "/etc/config.txt", "/etc/fonts", "/home",
+   * "/home/alice", ...]}
    *
    * @since 23.5
    */

diff --git a/guava/src/com/google/common/io/MoreFiles.java b/guava/src/com/google/common/io/MoreFiles.java
@@ -283,8 +283,9 @@ public static ImmutableList<Path> listFiles(Path dir) throws IOException {
    * created by this traverser if an {@link IOException} is thrown by a call to {@link
    * #listFiles(Path)}.
    *
-   * <p>Example: {@code MoreFiles.fileTraverser().breadthFirst("/")} may return files with the
-   * following paths: {@code ["/", "/etc", "/home", "/usr", "/etc/config.txt", "/etc/fonts", ...]}
+   * <p>Example: {@code MoreFiles.fileTraverser().depthFirstPreOrder(Paths.get("/"))} may return the
+   * following paths: {@code ["/", "/etc", "/etc/config.txt", "/etc/fonts", "/home", "/home/alice",
+   * ...]}
    *
    * @since 23.5
    */