Cache

interface Cache<K, V>

Mutable, fixed-capacity cache whose eviction strategy depends on the specific implementation

Parameters

is the type of the keys used for indexing items in this cache

is the type of the values stored in this cache

Companion

common

get

common

abstract operator fun get(key: K): Optional<out V>

Retrieves the cached value corresponding to the provided key

getOrSet

common

open fun getOrSet(key: K, valueGenerator: () -> V): V

Retrieves the cached value corresponding to the provided key, or stores a cache for the key in case it is missing

set

common

abstract operator fun set(key: K, value: V): Optional<out Pair<K, V>>

Stores a new key-value pair in this cache, possibly evicting some previously stored key-value pair

toMap

common

abstract fun toMap(): Map<K, V>

Converts this cache to an immutable map

toSequence

common

Converts this cache to a sequenve of key-value pairs

capacity

common

abstract val capacity: Int

Retrieves the maximum amount of items this cache may ever store

size

common

abstract val size: Int

Retrieves the amount of items currently cached by this cache