0.31.6

kform/tech.ostack.kform.datatypes/Table

Table

@Serializable(with = Table.RowsSerializer::class)

class Table<T>(source)

Collection where each value has a stable identifier.

Constructors

constructor()

constructor(initialCapacity: Int)

constructor(table: Table<T>)

constructor(map: Map<TableRowId, T>)

constructor(values: Collection<T>)

Types

class RowsSerializer<T>(valueSerializer: KSerializer<T>) : KSerializer<Table<T>>

Table serialiser that serialises the table as a map, mapping each row id to its respective value.

ValuesSerializer

class ValuesSerializer<T>(valueSerializer: KSerializer<T>) : KSerializer<Table<T>>

Table serialiser that serialises the values of the table as a list, ignoring the ids of all table rows.

Properties

val ids: Set<TableRowId>

Set of all identifiers of the table.

val nextId: TableRowId

Identifier of the next row (when incremented automatically).

val rows: Set<TableRow<T>>

Set of all rows of the table.

Size of the table.

val values: Collection<T>

Collection of all values of the table.

Functions

fun add(value: T): TableRowId

Adds a new row with the provided value to the table. Returns the identifier of the newly added row.

fun addAll(values: Collection<T>): List<TableRowId>

Adds all provided values to the table. Returns a list with the identifiers of all newly added rows.

fun addAllAt(index: Int, values: Collection<T>): List<TableRowId>

Adds all provided values to the table at the provided index. Returns a list with the identifiers of all newly added rows.

fun addAt(index: Int, value: T): TableRowId

Adds a new row with the provided value at the provided index. Returns the identifier of the newly added row.

fun clear()

Clears the table by removing all of its rows.

inline operator fun contains(value: T): Boolean

Whether the table contains a row with the provided value.

inline operator fun contains(id: TableRowId): Boolean

Whether the table contains a row with the provided id.

fun containsId(id: TableRowId): Boolean

Whether the table contains a row with the provided id.

fun containsValue(value: T): Boolean

Whether the table contains a row with the provided value.

open operator override fun equals(other: Any?): Boolean

operator fun get(id: TableRowId): T?

Returns the value of the row with the provided id.

open override fun hashCode(): Int

fun idAt(index: Int): TableRowId

Returns the identifier of the row at the provided index.

fun indexOfId(id: TableRowId): Int

Returns the index of the row with the provided id or -1 when no such row exists.

fun indexOfValue(value: T): Int

Returns the index of the row with the provided value or -1 when no such row exists.

fun isEmpty(): Boolean

Whether the table is empty.

lastIndexOfValue

fun lastIndexOfValue(value: T): Int

Returns the last index of the row with the provided value or -1 when no such row exists.

inline operator fun minusAssign(id: TableRowId)

Removes the row with the provided id. This simply calls remove while ignoring the returned element. If you require knowing which element was removed, use remove instead.

inline operator fun plusAssign(value: T)

Adds a new row with the provided value to the table. This simply calls add while ignoring the returned identifier. If you require knowing the identifier of the newly added row, use add instead.

fun remove(id: TableRowId): T?

Removes the row with the provided id. Returns the element of the removed row or null if no such row exists.

fun removeAt(index: Int): TableRow<T>

Removes the row at the provided index. Returns the removed row.

fun rowAt(index: Int): TableRow<T>

Returns the row at the provided index.

operator fun set(id: TableRowId, value: T): T?

Sets the value of a row with the provided id. If no such row exists, then it will be created. Returns the value previously at said row or null if no such row existed.

fun setAt(index: Int, value: T): T?

Sets the value of the row at the provided index. If index == size, a new row is added. Returns the value previously at said row or null if no such row existed.

fun subList(fromIndex: Int, toIndex: Int): List<TableRow<T>>

Returns a sub-list representation of the table from index fromIndex (inclusive) to index toIndex (exclusive).

fun <T> Table<T>.toMap(): MutableMap<TableRowId, T>

Creates a new Map from a table.

open override fun toString(): String

fun <T> Table<T>.toTable(): Table<T>

Creates a copy of the provided table.

fun valueAt(index: Int): T

Returns the value of the row at the provided index.