stdlib/kotlin.io.path/OnErrorResult

OnErrorResult

enum OnErrorResult : Enum<OnErrorResult> (source)

The result of the onError function passed to Path.copyToRecursively that specifies further actions when an exception occurs.

Since Kotlin

1.8

Entries

SKIP_SUBTREE

If the entry that caused the error is a directory, skip the directory and its content, and continue with the next entry outside this directory in the traversal order. Otherwise, skip this entry and continue with the next entry in the traversal order.

TERMINATE

Stop the recursive copy function. The function will return without throwing exception. To terminate the function with an exception rethrow instead.

Functions

valueOf

fun valueOf(value: String): OnErrorResult

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.0

values

fun values(): Array<OnErrorResult>

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

Since Kotlin 1.0

Properties

name

val name: String

Since Kotlin 1.0

ordinal

val ordinal: Int

Since Kotlin 1.0

Extensions

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

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