Интерфейс DirectoryStream<T>

public interface DirectoryStream<T>
extends Closeable, Iterable<T>

Объект для итерирования по записям в каталоге. Поток каталога позволяет удобно использовать конструкцию for-each для итерирования по каталогу.

Хотя DirectoryStream расширяет Iterable, он не является универсальным Iterable, так как поддерживает только один Iterator; вызов метода iterator для получения второго или последующего итератора вызывает IllegalStateException.

Важной особенностью потока каталога является то, что его метод hasNext гарантированно предварительно читает как минимум один элемент. Если метод hasNext возвращает true, и за ним следует вызов метода next, гарантируется, что метод next не выбросит исключение из-за ошибки ввода-вывода или потому, что поток был closed. Поток каталога не поддерживает операцию remove.

Поток каталога открывается при создании и закрывается вызовом метода close. Закрытие потока каталога высвобождает все ресурсы, связанные с потоком. Отсутствие закрытия потока может привести к утечке ресурсов. Инструкция try-with-resources обеспечивает полезную конструкцию для гарантированного закрытия потока:

Path dir = ...
   try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir)) {
       for (Path entry: stream) {
           ...
       }
   }

После закрытия потока каталога дальнейший доступ к каталогу с помощью Iterator ведет себя так, как будто достигнут конец потока. Из-за предварительного чтения Iterator может вернуть один или несколько элементов после закрытия потока каталога. После прочтения этих буферизованных элементов последующие вызовы метода hasNext возвращают false, а последующие вызовы метода next выбросят NoSuchElementException.

Поток каталога не обязан быть асинхронно закрываемым. Если поток заблокирован на итераторе потока каталога, читающем из каталога, а другой поток вызывает метод close, то второй поток может заблокироваться до завершения операции чтения.

Если при доступе к каталогу возникает ошибка ввода-вывода, то это заставляет методы Iterator's hasNext или next выбросить DirectoryIteratorException с IOException в качестве причины. Как указано выше, метод hasNext гарантированно предварительно читает как минимум один элемент. Это означает, что если метод hasNext возвращает true, а за ним следует вызов метода next, то гарантируется, что метод next не завершится с ошибкой DirectoryIteratorException.

Элементы, возвращаемые итератором, не упорядочены каким-либо определенным образом. Некоторые файловые системы поддерживают специальные ссылки на сам каталог и родительский каталог. Записи, представляющие эти ссылки, не возвращаются итератором.

Итератор слабо согласован. Он потокобезопасен, но не замораживает каталог во время итерирования, поэтому он может (или не может) отражать обновления каталога, произошедшие после создания DirectoryStream.

Примеры использования: Предположим, что нам нужен список исходных файлов в каталоге. В этом примере используются как конструкция for-each, так и try-with-resources.

List<Path> listSourceFiles(Path dir) throws IOException {
       List<Path> result = new ArrayList<>();
       try (DirectoryStream<Path> stream = Files.newDirectoryStream(dir, "*.{c,h,cpp,hpp,java}")) {
           for (Path entry: stream) {
               result.add(entry);
           }
       } catch (DirectoryIteratorException ex) {
           // I/O error encounted during the iteration, the cause is an IOException
           throw ex.getCause();
       }
       return result;
   }

Методы

iterator

Iterator<T> iterator()

Возвращает итератор, связанный с этим DirectoryStream.

Определено в:

iterator в интерфейсе Iterable<T>

Возвращает:

итератор, связанный с этим DirectoryStream

Исключения:

IllegalStateException - если этот поток каталога закрыт или итератор уже был возвращён