0.0.0-experiment-2025.3.27

kone.relations/dev.lounres.kone.relations/Order

Order

interface Order<in Element> : KoneContext(source)

Describes a context that provides linear (total) order as a compareTo.

Such contexts are used instead of usual compareTo operator defined right inside the Element type for several reasons. Some of them are:

Following structural pattern, any behaviour between elements should not be a part of the elements' logic but a part of assumed context. (For example, summing two integers together, we assume that we are summing them as two integer, but not as a residue of some modulo.)
Such separation of entities and operations over them brings modularity: you can change operations context leaving the entities the same.

Types

class Key<Element>(elementType: SuppliedType<Element>) : RegistryKey<Order<Element>>

Registry key for Order interface in KoneContextRegistry.

Functions

fun <Element> Order<Element>.asComparator(): Comparator<Element>

Converts provided Order receiver into Comparator that delegates its Comparator.compare operator to Order.compareTo operator.

abstract infix fun Element.compareWith(other: Element): ComparisonResult

Compares this and other elements.