0.0.0-experiment-2025.3.27

kone.relations/dev.lounres.kone.relations/ComparisonResult

ComparisonResult

enum ComparisonResult : Enum<ComparisonResult> (source)

Describes result of two elements comparison. See Order for the main application.

Names of the enumerated elements say for themselves.

Entries

LeftIsGreaterThanRight

LeftIsGreaterThanRight

LeftIsLessThanRight

LeftIsLessThanRight

Properties

val entries: EnumEntries<ComparisonResult>

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

val name: String

val ordinal: Int

Functions

asKotlinComparisonResult

fun ComparisonResult.asKotlinComparisonResult(): Int

Shortcut to convert comparison result from Comparable's and Order's terms to Kotlin stlib Comparator's and Kone Comparator's terms.

fun valueOf(value: String): ComparisonResult

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

fun values(): Array<ComparisonResult>

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