kotlin-stdlib/kotlin.io.path/PathWalkOption

PathWalkOption

@ExperimentalPathApi
enum PathWalkOption : Enum<PathWalkOption> (source)

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

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

Since Kotlin

1.7

Entries

Link copied to clipboard
INCLUDE_DIRECTORIES

Visits directories as well.

Link copied to clipboard
BREADTH_FIRST

Walks in breadth-first order.

Link copied to clipboard
FOLLOW_LINKS

Follows symbolic links to the directories they point to.

Properties

Link copied to clipboard
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
Link copied to clipboard
val entries: EnumEntries<PathWalkOption>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Since Kotlin 1.7
Link copied to clipboard
val name: String
Since Kotlin 1.7
Link copied to clipboard
val ordinal: Int
Since Kotlin 1.7

Functions

Link copied to clipboard
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
Link copied to clipboard
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 1.7
Link copied to clipboard
fun values(): Array<PathWalkOption>

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

Since Kotlin 1.7