affogato-structure/com.parsuomash.affogato.structure.object_pool/ObjectPool

ObjectPool

This class define a simple template of object pool pattern.

Example:

val customPool = ObjectPool<Int>()

Since

1.4.0

Inheritors

Constructors

ObjectPool

constructor()

Properties

objects

var objects: HashMap<String, T>

size

val size: Int

Pool size

Functions

first

fun first(): T

Returns the first value or throws an exception if pool is empty.

firstOrElse

inline fun firstOrElse(defaultValue: () -> T): T

Returns the first value, or the result of the defaultValue function if there was no entry.

firstOrNull

fun firstOrNull(): T?

Returns the first value, or null if this pool contains no entry.

get

operator fun get(key: String): T

Returns the value for the given key or throws an exception if there is no such key in the pool.

getOrElse

inline fun getOrElse(key: String, defaultValue: () -> T): T

Returns the value for the given key, or the result of the defaultValue function if there was no entry for the given key.

getOrNull

fun getOrNull(key: String): T?

Returns the value to which the specified key is mapped, or null if this pool contains no mapping for the key.

last

fun last(): T

Returns the last value or throws an exception if pool is empty.

lastOrElse

inline fun lastOrElse(defaultValue: () -> T): T

Returns the last value, or the result of the defaultValue function if there was no entry.

lastOrNull

fun lastOrNull(): T?

Returns the last value, or null if this pool contains no entry.

set

operator fun set(key: String, value: T)

Allows to use the index operator for storing values in a pool.