FileTreeWalk

kotlin-stdlib / kotlin.io / FileTreeWalk

Требования к платформе и версии: JVM (1.0)

class FileTreeWalk : Sequence<File>

Этот класс предназначен для реализации различных методов обхода файлов. Он позволяет итерироваться по всем файлам внутри заданного каталога.

Используйте расширенные функции File.walk, File.walkTopDown или File.walkBottomUp для создания экземпляра FileTreeWalk.

Если заданный путь — это просто файл, обходчик обрабатывает только его. Если заданный путь к файлу не существует, обходчик не обрабатывает ничего, то есть эквивалентен пустой последовательности.

Функции

Требования к платформе и версии: JVM (1.0)

iterator

Возвращает итератор, осуществляющий обход файлов.

fun iterator(): Iterator<File>

Требования к платформе и версии: JVM (1.0)

maxDepth

Устанавливает максимальную глубину дерева каталогов для обхода. По умолчанию ограничения нет.

fun maxDepth(depth: Int): FileTreeWalk

Требования к платформе и версии: JVM (1.0)

onEnter

Устанавливает предикат функцию, которая вызывается при входе в любой каталог перед посещением его файлов и перед самим посещением каталога.

fun onEnter(function: (File) -> Boolean): FileTreeWalk

Требования к платформе и версии: JVM (1.0)

onFail

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

fun onFail(
    function: (File, IOException) -> Unit
): FileTreeWalk

Требования к платформе и версии: JVM (1.0)

onLeave

Устанавливает обратный вызов функцию, который вызывается при выходе из любого каталога после посещения его файлов и самого каталога.

fun onLeave(function: (File) -> Unit): FileTreeWalk

Расширенные функции

Требования к платформе и версии: JVM (1.0)

filterIsInstance

Возвращает последовательность, содержащую все элементы, которые являются экземплярами указанного класса.

fun <R> Sequence<*>.filterIsInstance(
    klass: Class<R>
): Sequence<R>

Требования к платформе и версии: JVM (1.0)

filterIsInstanceTo

Добавляет все элементы, которые являются экземплярами указанного класса, в заданное место назначения.

fun <C : MutableCollection<in R>, R> Sequence<*>.filterIsInstanceTo(
    destination: C, 
    klass: Class<R>
): C

Требования к платформе и версии: JVM (1.0)

maxWith

fun <T> Sequence<T>.maxWith(comparator: Comparator<in T>): T?

Требования к платформе и версии: JVM (1.0)

minWith

fun <T> Sequence<T>.minWith(comparator: Comparator<in T>): T?

Требования к платформе и версии: JVM (1.4)

sumOf

Возвращает сумму всех значений, полученных в результате применения функции-селектора к каждому элементу в последовательности.

fun <T> Sequence<T>.sumOf(
    selector: (T) -> BigDecimal
): BigDecimal

fun <T> Sequence<T>.sumOf(
    selector: (T) -> BigInteger
): BigInteger

Требования к платформе и версии: JVM (1.0)

toSortedSet

Возвращает новый SortedSet всех элементов.

fun <T> Sequence<T>.toSortedSet(
    comparator: Comparator<in T>
): SortedSet<T>

© 2010–2022 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.io/-file-tree-walk/index.html