KSLCore/ksl.utilities/OrderedList

OrderedList

class OrderedList<T : Comparable<T>>

This class encapsulates a list that is ordered Unfortunately, if the element is changed after being added to the list such that the comparison changes, then the ordering of the list will not be maintained. Ideally, only immutable objects are placed in the list.

Author

rossetti

Parameters

the type held in the list

Constructors

constructor()

Properties

Functions

fun add(element: T): Boolean

The elements are added and the list is changed to maintain the order

fun addAll(elements: Collection<T>)

The elements are added and the ordering implied by the elements is maintained.

fun clear()

Removes all elements from the list

fun contains(element: T): Boolean

fun isEmpty(): Boolean

fun isNotEmpty(): Boolean

operator fun iterator(): MutableIterator<T>

fun remove(element: T): Boolean

fun remove(elementIndex: Int): T

The list order is maintained.

fun removeFirst(): T?

The list order is maintained.