text/org.k3lp.lib.text/K3MutableMarkerPool

K3MutableMarkerPool

interface K3MutableMarkerPool : K3MarkerPool(source)

A mutable marker pool that allocates and maintains the mapping between unique ids and marker names.

Once an id<->name mapping has been established, this mapping cannot change anymore. This implies that any form of overwrite or remove function is prohibited to be implemented on implementing classes.

For most cases, use mutableK3MarkerPoolOf to create a mutable marker pool implementation.

Functions

build

abstract fun build(): K3MarkerPool

Returns an immutable copy of this marker pool. Later allocations are not reflected in this copy.

getById

abstract fun getById(id: Int): K3Marker?

Gets the corresponding marker by unique numeric id, or null if there is no marker with such id.

getByName

abstract fun getByName(name: String): K3Marker?

Gets the corresponding marker by name, or null if there is no marker with such name.

getOrAllocateByName

abstract fun getOrAllocateByName(name: String): K3Marker

Gets the marker by name, or allocates a new marker.

K3MutableMarkerPool

See also

Functions