PathWalkOption

kotlin-stdlib/kotlin.io.path/PathWalkOption

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

enum PathWalkOption : Enum<PathWalkOption>

Перечисление для задания параметров обхода функции Path.walk. Параметры можно комбинировать, чтобы задать желаемый порядок и поведение обхода.

Пример:

val startDirectory = createTempDirectory()
run {
    (startDirectory / "1" / "2" / "3" / "4").createDirectories()
    (startDirectory / "1" / "2" / "3" / "a.txt").createFile()
    (startDirectory / "1" / "2" / "b.txt").createFile()
    (startDirectory / "c.txt").createFile()
}

// Default walk options. Prints:
//    1/2/b.txt
//    1/2/3/a.txt
//    c.txt
startDirectory.walk().forEach { path ->
    println(path.relativeTo(startDirectory))
}

// Custom walk options. Prints:
//    1
//    c.txt
//    1/2
//    1/2/b.txt
//    1/2/3
//    1/2/3/a.txt
//    1/2/3/4
startDirectory.walk(PathWalkOption.INCLUDE_DIRECTORIES, PathWalkOption.BREADTH_FIRST).forEach { path ->
    println(path.relativeTo(startDirectory))
}

Обратите внимание, что это перечисление не является исчерпывающим, и в будущем могут быть добавлены новые варианты.

Элементы

INCLUDE_DIRECTORIES

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

INCLUDE_DIRECTORIES

Включает пути к каталогам в результирующую последовательность обхода.

BREADTH_FIRST

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

BREADTH_FIRST

Выполняет обход в ширину.

FOLLOW_LINKS

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

FOLLOW_LINKS

Переходит по символическим ссылкам к каталогам, на которые они указывают.

Свойства

declaringJavaClass

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

val <E : Enum<E>> Enum<E>.declaringJavaClass: Class<E>

Возвращает экземпляр Java Class перечисления, которому принадлежит заданная константа.

entries

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

val entries: EnumEntries<PathWalkOption>

Возвращает представление в виде неизменяемого списка всех элементов перечисления в порядке их объявления.

name

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

actual val name: String

Возвращает имя этой константы перечисления в точности в том виде, в котором оно указано в объявлении перечисления.

ordinal

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

actual val ordinal: Int

Возвращает порядковый номер этой константы перечисления (её позицию в объявлении перечисления, где начальной константе присваивается номер 0).

Функции

compareTo

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

infix inline fun <T> Comparable<T>.compareTo(other: T): Int

Сравнивает этот объект с указанным объектом на предмет порядка. Возвращает ноль, если этот объект равен указанному другому объекту, отрицательное число, если он меньше другого, или положительное число, если он больше другого.

valueOf

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

fun valueOf(value: String): PathWalkOption

Возвращает константу этого типа перечисления с указанным именем. Строка должна в точности совпадать с идентификатором, использованным для объявления константы перечисления этого типа. (Лишние пробельные символы не допускаются.)

values

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

fun values(): Array<PathWalkOption>

Возвращает массив, содержащий константы этого типа перечисления в порядке их объявления.

© 2010–2026 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.io.path/-path-walk-option/index.html