kotlin-stdlib/kotlin.io.path/PathWalkOption

PathWalkOption

enum class PathWalkOption : Enum<PathWalkOption> (source)

An enumeration to provide walk options for the Path.walk function. The options can be combined to form the desired walk order and behavior.

Example:

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))
}

Note that this enumeration is not exhaustive, and new cases might be added in the future.

Since Kotlin

2.1

Entries

INCLUDE_DIRECTORIES

Includes directory paths in the resulting sequence of the walk.

BREADTH_FIRST

Walks in breadth-first order.

FOLLOW_LINKS

Follows symbolic links to the directories they point to.

Companion properties

entries

val entries: EnumEntries<PathWalkOption>

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

Since Kotlin 2.1

Companion functions

valueOf

fun valueOf(value: String): PathWalkOption

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Since Kotlin 2.1

values

fun values(): Array<PathWalkOption>

Returns an array containing the constants of this enum type, in the order they're declared.

Since Kotlin 2.1

Properties

declaringJavaClass

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

Returns a Java Class instance of the enum the given constant belongs to.

Since Kotlin 1.7

name

actual val name: String

Returns the name of this enum constant, exactly as declared in its enum declaration.

Since Kotlin 2.1

ordinal

actual val ordinal: Int

Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).

Since Kotlin 2.1

Functions

compareTo

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

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.6

Thanks for your feedback!

Was this page helpful?