feat(recursive-access): Seção de acessar diretórios.

Criação da seção sobre acesso de diretório, de forma recursiva ou não, utilizando DirectoryStream e FileVisitor.

Ref. Issue #35

Author: rinaldodev

book/07-file-io/sections/03-recursive-access.asc

@@ -0,0 +1,198 @@
+:java-package: src/org/j6toj8/fileio
+:section-java-package: ../../../{java-package}
+
+=== DirectoryStream e FileVisitor
+
+.Objetivo
+--------------------------------------------------
+Recursively access a directory tree by using the DirectoryStream and FileVisitor interfaces
+-
+Acessar recursivamente uma árvore de diretório usando as interfaces DirectoryStream e FileVisitor
+--------------------------------------------------
+
+Nestão seção serão apresentadas duas classes para percorrer diretórios: `DirectoryStream` e `FileVisitor`.
+
+. É possível checar vários atributos de um `Path` utilizando a classe `Files`.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_DirectoryStream.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_DirectoryStream.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+/home/rinaldo/arquivos/arquivo1.txt
+/home/rinaldo/arquivos/arquivo3.txt
+/home/rinaldo/arquivos/subpasta1
+/home/rinaldo/arquivos/arquivo2.txt
+/home/rinaldo/arquivos/arquivo1.txt
+/home/rinaldo/arquivos/arquivo3.txt
+/home/rinaldo/arquivos/subpasta1
+/home/rinaldo/arquivos/arquivo2.txt
+----
++
+Perceba que a instância de `DirectoryStream`:
++
+* Pode ser utilizada com try-with-resources.
+* Pode ser iterada com a sintaxe de for-each.
+* Pode ser iterada com o método `forEach` que recebe uma expressão lambda.
+* Lança exceção caso o arquivo não exista.
+* Não lista os subdiretórios de forma recursiva, mas sim apenas o primeiro nível.
+* Não tem relação com a API de _Streams_ do Java 8.
+
+. É possível acessar toda uma árvore de diretórios utilizando um `FileVisitor`.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_SimpleFileVisitor.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_SimpleFileVisitor.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+Arquivo visitado: /home/rinaldo/arquivos/arquivo1.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/arquivo3.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo122.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo121.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo11.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo12.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo13.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/arquivo2.txt. Tamanho: 2
+----
++
+Perceba que todos os arquivos do diretório e subdiretórios foram visitados e impressos no console ao invocar `Files.walkFileTree`. Para cada arquivo encontrado foi invocado o método `visitFile` da instância de `MeuFileVisitor`.
++
+Veja que foi retornado `FileVisitResult.CONTINUE` do método `visitFile`. Isso instrui o FileVisitor a continuar visitando a árvore de arquivos. Também é possível retornar `TERMINATE`, `SKIP_SUBTREE` e `SKIP_SIBLINGS`, que serão apresentados a seguir.
+
+. É possível finalizar a visitação quando for necessário retornando `FileVisitResult.TERMINATE`.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_VisitorTerminate.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_VisitorTerminate.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+Arquivo visitado: /home/rinaldo/arquivos/arquivo1.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/arquivo3.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo122.txt. Tamanho: 10
+Arquivo encontrado. Finalizando.
+----
+
+. Também é possível tomar decisões antes e depois de visitar diretórios.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_VisitorDirectory.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_VisitorDirectory.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+Arquivo visitado: /home/rinaldo/arquivos/arquivo1.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/arquivo3.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo11.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo12.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo13.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/arquivo2.txt. Tamanho: 2
+----
+
+. Também é possível ignorar todos os elementos que estão no mesmo nível de um `Path`.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_VisitorIgnoreSiblings.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_VisitorIgnoreSiblings.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+Arquivo visitado: /home/rinaldo/arquivos/arquivo1.txt. Tamanho: 2
+Arquivo visitado: /home/rinaldo/arquivos/arquivo3.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo122.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo121.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo11.txt. Tamanho: 10
+Arquivo visitado: /home/rinaldo/arquivos/arquivo2.txt. Tamanho: 2
+----
+
+. É possível implementar diretamente a interface `FileVisitor`, ao invés de `SimpleFileVisitor`, e implementar todos os seus métodos.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_FileVisitor.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_FileVisitor.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+Antes de visitar o diretório: /home/rinaldo/arquivos
+Arquivo visitado: /home/rinaldo/arquivos/arquivo1.txt
+Arquivo visitado: /home/rinaldo/arquivos/arquivo3.txt
+Antes de visitar o diretório: /home/rinaldo/arquivos/subpasta1
+Antes de visitar o diretório: /home/rinaldo/arquivos/subpasta1/subpasta12
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo122.txt
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12/arquivo121.txt
+Após de visitar o diretório: /home/rinaldo/arquivos/subpasta1/subpasta12
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo11.txt
+Antes de visitar o diretório: /home/rinaldo/arquivos/subpasta1/subpasta11
+Após de visitar o diretório: /home/rinaldo/arquivos/subpasta1/subpasta11
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo12.txt
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo13.txt
+Após de visitar o diretório: /home/rinaldo/arquivos/subpasta1
+Arquivo visitado: /home/rinaldo/arquivos/arquivo2.txt
+Após de visitar o diretório: /home/rinaldo/arquivos
+----
+
+. É possível definir opções adicionais e limitar a profundidade utilizando outra versão do método `walkFileTree`.
++
+[source,java,indent=0]
+.{java-package}/recursiveaccess/Recursive_VisitorOptionsAndDepth.java
+----
+include::{section-java-package}/recursiveaccess/Recursive_VisitorOptionsAndDepth.java[tag=code]
+----
++
+.Saída no console
+[source,console]
+----
+Path: /home/rinaldo/arquivos
+Arquivo visitado: /home/rinaldo/arquivos/arquivo1.txt
+Arquivo visitado: /home/rinaldo/arquivos/arquivo3.txt
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta12
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo11.txt
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/subpasta11
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo12.txt
+Arquivo visitado: /home/rinaldo/arquivos/subpasta1/arquivo13.txt
+Arquivo visitado: /home/rinaldo/arquivos/arquivo2.txt
+----
+
+****
+
+* Working with Directories
++
+Boyarsky, Jeanne; Selikoff, Scott. OCP: Oracle Certified Professional Java SE 8 Programmer II Study Guide (p. 617). Wiley. Edição do Kindle. 
+
+* https://www.baeldung.com/java-list-directory-files[List Files in a Directory in Java.]
+
+* https://www.baeldung.com/java-nio2-file-visitor[A Guide To NIO2 FileVisitor.]
+
+* https://docs.oracle.com/javase/7/docs/api/java/nio/file/DirectoryStream.html[Class DirectoryStream.] Java Plataform SE 7.
+
+* https://docs.oracle.com/javase/7/docs/api/java/nio/file/FileVisitor.html[Class FileVisitor.] Java Plataform SE 7.
+
+* https://docs.oracle.com/javase/tutorial/essential/io/pathOps.html[Path Operations.] The Java™ Tutorials.
+
+****

ch07-java-file-io.asc

@@ -2,4 +2,5 @@
 == Java File I/O (NIO.2)
 
 include::book/07-java-file-io/sections/01-paths.asc[]
-include::book/07-java-file-io/sections/02-files.asc[]
+include::book/07-java-file-io/sections/02-files.asc[]
+include::book/07-java-file-io/sections/03-recursive-access.asc[]

src/org/j6toj8/fileio/recursiveaccess/Recursive_DirectoryStream.java

@@ -0,0 +1,35 @@
+package org.j6toj8.fileio.recursiveaccess;
+
+import java.io.IOException;
+import java.nio.file.DirectoryStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+public class Recursive_DirectoryStream {
+
+  public static void main(String[] args) {
+    // tag::code[]
+    String userHome = System.getProperty("user.home");
+    Path path = Paths.get(userHome, "arquivos");
+    System.out.println("Path: " + path);
+
+    try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(path)) {
+      // iteração com sintaxe for-each
+      for (Path subPath : directoryStream) {
+        System.out.println(subPath);
+      }
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+    
+    try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(path)) {
+      // iteração com operação forEach e expressão lambda
+      directoryStream.forEach(p -> System.out.println(p));
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+    // end::code[]
+  }
+
+}

src/org/j6toj8/fileio/recursiveaccess/Recursive_FileVisitor.java

@@ -0,0 +1,52 @@
+package org.j6toj8.fileio.recursiveaccess;
+
+import java.io.IOException;
+import java.nio.file.FileVisitResult;
+import java.nio.file.FileVisitor;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.attribute.BasicFileAttributes;
+
+public class Recursive_FileVisitor {
+
+  // tag::code[]
+  static class MeuFileVisitor implements FileVisitor<Path> {
+    @Override
+    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+      System.out.println("Arquivo visitado: " + file);
+      return FileVisitResult.CONTINUE;
+    }
+    
+    @Override
+    public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
+      System.out.println("Antes de visitar o diretório: " + dir);
+      return FileVisitResult.CONTINUE;
+    }
+    
+    @Override
+    public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
+      System.out.println("Após de visitar o diretório: " + dir);
+      return FileVisitResult.CONTINUE;
+    }
+
+    @Override
+    public FileVisitResult visitFileFailed(Path file, IOException exc) throws IOException {
+      System.out.println("Falhou ao visitar o arquivo: " + file);
+      return FileVisitResult.CONTINUE;
+    }
+  }
+  
+  public static void main(String[] args) {
+    String userHome = System.getProperty("user.home");
+    Path path = Paths.get(userHome, "arquivos");
+    System.out.println("Path: " + path);
+    try {
+      Files.walkFileTree(path, new MeuFileVisitor());
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+  }
+  // end::code[]
+
+}

src/org/j6toj8/fileio/recursiveaccess/Recursive_SimpleFileVisitor.java

@@ -0,0 +1,38 @@
+package org.j6toj8.fileio.recursiveaccess;
+
+import java.io.IOException;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
+
+public class Recursive_SimpleFileVisitor {
+
+  // tag::code[]
+  // Implementação simples de um SimpleFileVisitor
+  static class MeuFileVisitor extends SimpleFileVisitor<Path> {
+    @Override
+    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+      // Método que será invocado a cada arquivo encontrado
+      System.out.println("Arquivo visitado: " + file + ". Tamanho: " + attrs.size());
+      return FileVisitResult.CONTINUE; // instrui o FileVisitor a continuar seguindo a árvore de arquivos
+    }
+  }
+  
+  public static void main(String[] args) {
+    String userHome = System.getProperty("user.home");
+    Path path = Paths.get(userHome, "arquivos");
+    System.out.println("Path: " + path);
+    try {
+      // Utilização da classe MeuFileVisitor para acessar
+      // todos os arquivos no diretório e seus subdiretórios
+      Files.walkFileTree(path, new MeuFileVisitor());
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+  }
+  // end::code[]
+
+}

src/org/j6toj8/fileio/recursiveaccess/Recursive_VisitorDirectory.java

@@ -0,0 +1,50 @@
+package org.j6toj8.fileio.recursiveaccess;
+
+import java.io.IOException;
+import java.nio.file.FileVisitResult;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.nio.file.SimpleFileVisitor;
+import java.nio.file.attribute.BasicFileAttributes;
+
+public class Recursive_VisitorDirectory {
+
+  // tag::code[]
+  static class MeuFileVisitor extends SimpleFileVisitor<Path> {
+    @Override
+    public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+      System.out.println("Arquivo visitado: " + file + ". Tamanho: " + attrs.size());
+      return FileVisitResult.CONTINUE;
+    }
+    
+    @Override
+    public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
+      // Ação que será executada antes de visitar um diretório
+      if (dir.getFileName().toString().equals("subpasta12")) {
+        return FileVisitResult.SKIP_SUBTREE; // ignora o diretório subpasta12
+      }
+      return FileVisitResult.CONTINUE;
+    }
+    
+    @Override
+    public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOException {
+      // Ação que será executada depois de visitar um diretório
+      return FileVisitResult.CONTINUE;
+    }
+    
+  }
+  
+  public static void main(String[] args) {
+    String userHome = System.getProperty("user.home");
+    Path path = Paths.get(userHome, "arquivos");
+    System.out.println("Path: " + path);
+    try {
+      Files.walkFileTree(path, new MeuFileVisitor());
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+  }
+  // end::code[]
+
+}