kotlin-stdlib/kotlin.io.path/CopyActionResult

CopyActionResult

enum CopyActionResult : Enum<CopyActionResult> (source)

The result of the copyAction function passed to Path.copyToRecursively that specifies further actions when copying an entry.

Since Kotlin

1.8

Entries

CONTINUE

Continue with the next entry in the traversal order.

SKIP_SUBTREE

Skip the directory content, continue with the next entry outside the directory in the traversal order. For files this option is equivalent to CONTINUE.

TERMINATE

Stop the recursive copy function. The function will return without throwing exception.

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

entries

val entries: EnumEntries<CopyActionResult>

Since Kotlin 1.8

name

actual val name: String

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

Since Kotlin 1.8

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 1.8

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

valueOf

fun valueOf(value: String): CopyActionResult

Since Kotlin 1.8

values

fun values(): Array<CopyActionResult>

Since Kotlin 1.8

Thanks for your feedback!

Was this page helpful?