From 3d76e7d2e3f0d604b2111df9370fd54e40a407b7 Mon Sep 17 00:00:00 2001 From: ychescale9 Date: Fri, 23 Feb 2024 12:33:41 +0000 Subject: [PATCH] Deployed d5229b2 with MkDocs version: 1.5.3 --- api/cache4k/index.html | 10 +-- .../-cache-event-listener/index.html | 14 ++-- .../-cache-event-listener/on-event.html | 6 +- .../-cache-event/-created/-created.html | 6 +- .../-cache-event/-created/equals.html | 6 +- .../-cache-event/-created/hash-code.html | 6 +- .../-cache-event/-created/index.html | 54 +++++++-------- .../-cache-event/-created/key.html | 6 +- .../-cache-event/-created/to-string.html | 6 +- .../-cache-event/-created/value.html | 6 +- .../-cache-event/-evicted/-evicted.html | 6 +- .../-cache-event/-evicted/equals.html | 6 +- .../-cache-event/-evicted/hash-code.html | 6 +- .../-cache-event/-evicted/index.html | 54 +++++++-------- .../-cache-event/-evicted/key.html | 6 +- .../-cache-event/-evicted/to-string.html | 6 +- .../-cache-event/-evicted/value.html | 6 +- .../-cache-event/-expired/-expired.html | 6 +- .../-cache-event/-expired/equals.html | 6 +- .../-cache-event/-expired/hash-code.html | 6 +- .../-cache-event/-expired/index.html | 54 +++++++-------- .../-cache-event/-expired/key.html | 6 +- .../-cache-event/-expired/to-string.html | 6 +- .../-cache-event/-expired/value.html | 6 +- .../-cache-event/-removed/-removed.html | 6 +- .../-cache-event/-removed/equals.html | 6 +- .../-cache-event/-removed/hash-code.html | 6 +- .../-cache-event/-removed/index.html | 54 +++++++-------- .../-cache-event/-removed/key.html | 6 +- .../-cache-event/-removed/to-string.html | 6 +- .../-cache-event/-removed/value.html | 6 +- .../-cache-event/-updated/-updated.html | 6 +- .../-cache-event/-updated/equals.html | 6 +- .../-cache-event/-updated/hash-code.html | 6 +- .../-cache-event/-updated/index.html | 62 +++++++++--------- .../-cache-event/-updated/key.html | 6 +- .../-cache-event/-updated/new-value.html | 6 +- .../-cache-event/-updated/old-value.html | 6 +- .../-cache-event/-updated/to-string.html | 6 +- .../-cache-event/index.html | 54 +++++++-------- .../-cache-event/key.html | 6 +- .../-cache/-builder/-companion/index.html | 14 ++-- .../-cache/-builder/-companion/invoke.html | 6 +- .../-cache/-builder/build.html | 6 +- .../-cache/-builder/event-listener.html | 6 +- .../-cache/-builder/expire-after-access.html | 6 +- .../-cache/-builder/expire-after-write.html | 6 +- .../-cache/-builder/index.html | 62 +++++++++--------- .../-cache/-builder/maximum-cache-size.html | 6 +- .../-cache/-builder/time-source.html | 6 +- .../-cache/as-map.html | 6 +- .../-cache/get.html | 6 +- .../-cache/index.html | 54 +++++++-------- .../-cache/invalidate-all.html | 6 +- .../-cache/invalidate.html | 6 +- .../-cache/put.html | 6 +- .../-fake-time-source/-fake-time-source.html | 6 +- .../-fake-time-source/index.html | 32 ++++----- .../-fake-time-source/plus-assign.html | 6 +- .../index.html | 36 +++++----- api/cache4k/navigation.html | 26 ++++---- api/navigation.html | 26 ++++---- api/scripts/sourceset_dependencies.js | 2 +- changelog/index.html | 2 +- search/search_index.json | 2 +- sitemap.xml.gz | Bin 225 -> 225 bytes 66 files changed, 447 insertions(+), 447 deletions(-) diff --git a/api/cache4k/index.html b/api/cache4k/index.html index 945f7de..48c6ba2 100644 --- a/api/cache4k/index.html +++ b/api/cache4k/index.html @@ -45,7 +45,7 @@
- +
@@ -58,19 +58,19 @@
-
+

cache4k

Packages

-
-
+
+
- +
Link copied to clipboard
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/index.html index 5c92f8a..4e91c65 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEventListener

CacheEventListener

-
fun interface CacheEventListener<Key : Any, Value : Any>

Definition of the contract for implementing listeners to receive CacheEvents from a Cache.

+
fun interface CacheEventListener<Key : Any, Value : Any>

Definition of the contract for implementing listeners to receive CacheEvents from a Cache.

Functions

-
-
+
+
- +
Link copied to clipboard
-
abstract fun onEvent(event: CacheEvent<Key, Value>)

Invoked on CacheEvent firing.

+
abstract fun onEvent(event: CacheEvent<Key, Value>)

Invoked on CacheEvent firing.

diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/on-event.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/on-event.html index 963eff0..f0ef696 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/on-event.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event-listener/on-event.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEventListener/onEvent

onEvent

-
abstract fun onEvent(event: CacheEvent<Key, Value>)

Invoked on CacheEvent firing.

Cache entry event firing behaviors for mutative methods:

{}put(K, V){K: V}Created(K, V)
{K: V1}put(K, V2){K: V2}Updated(K, V1, V2)
{K: V}invalidate(K){}Removed(K, V)
{K1: V1, K2: V2}invalidateAll(){}Removed(K1, V1), Removed(K2, V2)
{K: V}any operation, K expired{}Expired(K, V)
{K1: V1}put(K2, V2), K1 evicted{K2: V2}Created(K2, V2), Evicted(K1, V1)
+
abstract fun onEvent(event: CacheEvent<Key, Value>)

Invoked on CacheEvent firing.

Cache entry event firing behaviors for mutative methods:

Initial valueOperationNew valueEvent
{}put(K, V){K: V}Created(K, V)
{K: V1}put(K, V2){K: V2}Updated(K, V1, V2)
{K: V}invalidate(K){}Removed(K, V)
{K1: V1, K2: V2}invalidateAll(){}Removed(K1, V1), Removed(K2, V2)
{K: V}any operation, K expired{}Expired(K, V)
{K1: V1}put(K2, V2), K1 evicted{K2: V2}Created(K2, V2), Evicted(K1, V1)
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/-created.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/-created.html index 823efa1..50d507c 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/-created.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/-created.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created/Created

Created

-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/equals.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/equals.html index 147ae28..567e7a9 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/equals.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/equals.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created/equals

equals

-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/hash-code.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/hash-code.html index ca60fb3..f97a5d4 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/hash-code.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/hash-code.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created/hashCode

hashCode

-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/index.html index 9f37934..ad405da 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created

Created

-
class Created<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Created<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>

Constructors

-
-
+
+
- +
Link copied to clipboard
-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
@@ -88,32 +88,32 @@

Constructors

Properties

-
-
+
+
- +
Link copied to clipboard
-
open override val key: Key
+
open override val key: Key
- -
+ +
- +
Link copied to clipboard
-
val value: Value
+
val value: Value
@@ -122,47 +122,47 @@

Properties

Functions

-
-
+
+
- +
Link copied to clipboard
-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
- -
+ +
- +
Link copied to clipboard
-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
- -
+ +
- +
Link copied to clipboard
-
open override fun toString(): String
+
open override fun toString(): String
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/key.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/key.html index 1cd2898..f7b8074 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/key.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/key.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created/key

key

-
open override val key: Key
+
open override val key: Key
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/to-string.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/to-string.html index 3f13d0e..7a827dc 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/to-string.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/to-string.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created/toString

toString

-
open override fun toString(): String
+
open override fun toString(): String
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/value.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/value.html index ead8163..9d8b389 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/value.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-created/value.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Created/value

value

-
val value: Value
+
val value: Value
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/-evicted.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/-evicted.html index 88a386c..d4cf322 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/-evicted.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/-evicted.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted/Evicted

Evicted

-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/equals.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/equals.html index 35ecbd3..b70398e 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/equals.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/equals.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted/equals

equals

-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/hash-code.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/hash-code.html index 5de2dbb..cb020fc 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/hash-code.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/hash-code.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted/hashCode

hashCode

-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/index.html index 4a44c32..3b454ce 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted

Evicted

-
class Evicted<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Evicted<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>

Constructors

-
-
+
+
- +
Link copied to clipboard
-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
@@ -88,32 +88,32 @@

Constructors

Properties

-
-
+
+
- +
Link copied to clipboard
-
open override val key: Key
+
open override val key: Key
- -
+ +
- +
Link copied to clipboard
-
val value: Value
+
val value: Value
@@ -122,47 +122,47 @@

Properties

Functions

-
-
+
+
- +
Link copied to clipboard
-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
- -
+ +
- +
Link copied to clipboard
-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
- -
+ +
- +
Link copied to clipboard
-
open override fun toString(): String
+
open override fun toString(): String
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/key.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/key.html index 3a4222b..9edb230 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/key.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/key.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted/key

key

-
open override val key: Key
+
open override val key: Key
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/to-string.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/to-string.html index 22a70c4..4987628 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/to-string.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/to-string.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted/toString

toString

-
open override fun toString(): String
+
open override fun toString(): String
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/value.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/value.html index 00a1fa9..fdbaf05 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/value.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-evicted/value.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Evicted/value

value

-
val value: Value
+
val value: Value
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/-expired.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/-expired.html index 51d4deb..fce4767 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/-expired.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/-expired.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired/Expired

Expired

-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/equals.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/equals.html index 18967e4..85b9cee 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/equals.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/equals.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired/equals

equals

-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/hash-code.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/hash-code.html index ce91839..59a6f0d 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/hash-code.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/hash-code.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired/hashCode

hashCode

-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/index.html index caef468..5a0d002 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired

Expired

-
class Expired<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Expired<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>

Constructors

-
-
+
+
- +
Link copied to clipboard
-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
@@ -88,32 +88,32 @@

Constructors

Properties

-
-
+
+
- +
Link copied to clipboard
-
open override val key: Key
+
open override val key: Key
- -
+ +
- +
Link copied to clipboard
-
val value: Value
+
val value: Value
@@ -122,47 +122,47 @@

Properties

Functions

-
-
+
+
- +
Link copied to clipboard
-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
- -
+ +
- +
Link copied to clipboard
-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
- -
+ +
- +
Link copied to clipboard
-
open override fun toString(): String
+
open override fun toString(): String
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/key.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/key.html index 797563c..be6a830 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/key.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/key.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired/key

key

-
open override val key: Key
+
open override val key: Key
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/to-string.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/to-string.html index aa9bca3..5ea7d5c 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/to-string.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/to-string.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired/toString

toString

-
open override fun toString(): String
+
open override fun toString(): String
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/value.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/value.html index e776815..ae2f8ec 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/value.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-expired/value.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Expired/value

value

-
val value: Value
+
val value: Value
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/-removed.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/-removed.html index 05863a2..fb3976f 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/-removed.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/-removed.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed/Removed

Removed

-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/equals.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/equals.html index 106a420..de378f8 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/equals.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/equals.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed/equals

equals

-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/hash-code.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/hash-code.html index 45bea77..3ce4bbb 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/hash-code.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/hash-code.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed/hashCode

hashCode

-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/index.html index 30acade..7fd2a63 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed

Removed

-
class Removed<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Removed<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>

Constructors

-
-
+
+
- +
Link copied to clipboard
-
constructor(key: Key, value: Value)
+
constructor(key: Key, value: Value)
@@ -88,32 +88,32 @@

Constructors

Properties

-
-
+
+
- +
Link copied to clipboard
-
open override val key: Key
+
open override val key: Key
- -
+ +
- +
Link copied to clipboard
-
val value: Value
+
val value: Value
@@ -122,47 +122,47 @@

Properties

Functions

-
-
+
+
- +
Link copied to clipboard
-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
- -
+ +
- +
Link copied to clipboard
-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
- -
+ +
- +
Link copied to clipboard
-
open override fun toString(): String
+
open override fun toString(): String
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/key.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/key.html index 5c269fd..2112941 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/key.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/key.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed/key

key

-
open override val key: Key
+
open override val key: Key
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/to-string.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/to-string.html index 9fe3c60..3b3cb4e 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/to-string.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/to-string.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed/toString

toString

-
open override fun toString(): String
+
open override fun toString(): String
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/value.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/value.html index ce81815..8ed6eb6 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/value.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-removed/value.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Removed/value

value

-
val value: Value
+
val value: Value
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/-updated.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/-updated.html index 00d0338..48b1671 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/-updated.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/-updated.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/Updated

Updated

-
constructor(key: Key, oldValue: Value, newValue: Value)
+
constructor(key: Key, oldValue: Value, newValue: Value)
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/equals.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/equals.html index 02182d5..dda0b10 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/equals.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/equals.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/equals

equals

-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/hash-code.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/hash-code.html index f6d8a68..0e7e33a 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/hash-code.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/hash-code.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/hashCode

hashCode

-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/index.html index 6b1e86b..ad17590 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated

Updated

-
class Updated<Key : Any, Value : Any>(val key: Key, val oldValue: Value, val newValue: Value) : CacheEvent<Key, Value>
+
class Updated<Key : Any, Value : Any>(val key: Key, val oldValue: Value, val newValue: Value) : CacheEvent<Key, Value>

Constructors

-
-
+
+
- +
Link copied to clipboard
-
constructor(key: Key, oldValue: Value, newValue: Value)
+
constructor(key: Key, oldValue: Value, newValue: Value)
@@ -88,47 +88,47 @@

Constructors

Properties

-
-
+
+
- +
Link copied to clipboard
-
open override val key: Key
+
open override val key: Key
- -
+ +
- +
Link copied to clipboard
-
val newValue: Value
+
val newValue: Value
- -
+ +
- +
Link copied to clipboard
-
val oldValue: Value
+
val oldValue: Value
@@ -137,47 +137,47 @@

Properties

Functions

-
-
+
+
- +
Link copied to clipboard
-
open operator override fun equals(other: Any?): Boolean
+
open operator override fun equals(other: Any?): Boolean
- -
+ +
- +
Link copied to clipboard
-
open override fun hashCode(): Int
+
open override fun hashCode(): Int
- -
+ +
- +
Link copied to clipboard
-
open override fun toString(): String
+
open override fun toString(): String
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/key.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/key.html index 01c6ee4..983fd1d 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/key.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/key.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/key

key

-
open override val key: Key
+
open override val key: Key
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/new-value.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/new-value.html index a1fc759..84b2dab 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/new-value.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/new-value.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/newValue

newValue

-
val newValue: Value
+
val newValue: Value
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/old-value.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/old-value.html index d080858..50c3f78 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/old-value.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/old-value.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/oldValue

oldValue

-
val oldValue: Value
+
val oldValue: Value
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/to-string.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/to-string.html index 2e188cf..9a8d0d2 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/to-string.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/-updated/to-string.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/Updated/toString

toString

-
open override fun toString(): String
+
open override fun toString(): String
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/index.html index a37a790..7ca27b1 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/index.html @@ -45,7 +45,7 @@
- +
@@ -58,88 +58,88 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent

CacheEvent

-
interface CacheEvent<Key : Any, Value : Any>

An event resulting from a mutative Cache operation.

Inheritors

+
interface CacheEvent<Key : Any, Value : Any>

An event resulting from a mutative Cache operation.

Inheritors

Types

-
-
+
+
- +
Link copied to clipboard
-
class Created<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Created<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
- -
+ +
- +
Link copied to clipboard
-
class Evicted<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Evicted<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
- -
+ +
- +
Link copied to clipboard
-
class Expired<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Expired<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
- -
+ +
- +
Link copied to clipboard
-
class Removed<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
+
class Removed<Key : Any, Value : Any>(val key: Key, val value: Value) : CacheEvent<Key, Value>
- -
+ +
- +
Link copied to clipboard
-
class Updated<Key : Any, Value : Any>(val key: Key, val oldValue: Value, val newValue: Value) : CacheEvent<Key, Value>
+
class Updated<Key : Any, Value : Any>(val key: Key, val oldValue: Value, val newValue: Value) : CacheEvent<Key, Value>
@@ -148,17 +148,17 @@

Types

Properties

-
-
+
+
- +
Link copied to clipboard
-
abstract val key: Key
+
abstract val key: Key
diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/key.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/key.html index 7a990d9..18d3a44 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/key.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache-event/key.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/CacheEvent/key

key

-
abstract val key: Key
+
abstract val key: Key
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/index.html index 9fc1646..03e4505 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/Companion

Companion

-
object Companion
+
object Companion

Functions

-
-
+
+
- +
Link copied to clipboard
-
operator fun <K : Any, V : Any> invoke(): Cache.Builder<K, V>

Returns a new Cache.Builder instance.

+
operator fun <K : Any, V : Any> invoke(): Cache.Builder<K, V>

Returns a new Cache.Builder instance.

diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/invoke.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/invoke.html index d10322d..8c06a25 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/invoke.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/-companion/invoke.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/Companion/invoke

invoke

-
operator fun <K : Any, V : Any> invoke(): Cache.Builder<K, V>

Returns a new Cache.Builder instance.

+
operator fun <K : Any, V : Any> invoke(): Cache.Builder<K, V>

Returns a new Cache.Builder instance.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/build.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/build.html index 158fbaf..32a08c6 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/build.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/build.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/build

build

-
abstract fun build(): Cache<K, V>

Builds a new instance of Cache with the specified configurations.

+
abstract fun build(): Cache<K, V>

Builds a new instance of Cache with the specified configurations.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/event-listener.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/event-listener.html index 1b57868..43b0f0d 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/event-listener.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/event-listener.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/eventListener

eventListener

-
abstract fun eventListener(listener: CacheEventListener<K, V>): Cache.Builder<K, V>

Specifies a CacheEventListener to be used to handle cache events.

+
abstract fun eventListener(listener: CacheEventListener<K, V>): Cache.Builder<K, V>

Specifies a CacheEventListener to be used to handle cache events.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-access.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-access.html index 5bb3daf..cec1dd6 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-access.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-access.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/expireAfterAccess

expireAfterAccess

-
abstract fun expireAfterAccess(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access.

When duration is zero, the cache's max size will be set to 0 meaning no values will be cached.

+
abstract fun expireAfterAccess(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access.

When duration is zero, the cache's max size will be set to 0 meaning no values will be cached.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-write.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-write.html index ffddf86..2e93772 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-write.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/expire-after-write.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/expireAfterWrite

expireAfterWrite

-
abstract fun expireAfterWrite(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation or the most recent replacement of its value.

When duration is zero, the cache's max size will be set to 0 meaning no values will be cached.

+
abstract fun expireAfterWrite(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation or the most recent replacement of its value.

When duration is zero, the cache's max size will be set to 0 meaning no values will be cached.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/index.html index 180d3b2..cb8150d 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder

Builder

-
interface Builder<K : Any, V : Any>

Main entry point for creating a Cache.

+
interface Builder<K : Any, V : Any>

Main entry point for creating a Cache.

Types

-
-
+
+
- +
Link copied to clipboard
-
object Companion
+
object Companion
@@ -88,92 +88,92 @@

Types

Functions

-
-
+
+
- +
Link copied to clipboard
-
abstract fun build(): Cache<K, V>

Builds a new instance of Cache with the specified configurations.

+
abstract fun build(): Cache<K, V>

Builds a new instance of Cache with the specified configurations.

- -
+ +
- +
Link copied to clipboard
-
abstract fun eventListener(listener: CacheEventListener<K, V>): Cache.Builder<K, V>

Specifies a CacheEventListener to be used to handle cache events.

+
abstract fun eventListener(listener: CacheEventListener<K, V>): Cache.Builder<K, V>

Specifies a CacheEventListener to be used to handle cache events.

- -
+ +
- +
Link copied to clipboard
-
abstract fun expireAfterAccess(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access.

+
abstract fun expireAfterAccess(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation, the most recent replacement of its value, or its last access.

- -
+ +
- +
Link copied to clipboard
-
abstract fun expireAfterWrite(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation or the most recent replacement of its value.

+
abstract fun expireAfterWrite(duration: Duration): Cache.Builder<K, V>

Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry's creation or the most recent replacement of its value.

- -
+ +
- +
Link copied to clipboard
-
abstract fun maximumCacheSize(size: Long): Cache.Builder<K, V>

Specifies the maximum number of entries the cache may contain. Cache eviction policy is based on LRU - i.e. least recently accessed entries get evicted first.

+
abstract fun maximumCacheSize(size: Long): Cache.Builder<K, V>

Specifies the maximum number of entries the cache may contain. Cache eviction policy is based on LRU - i.e. least recently accessed entries get evicted first.

- -
+ +
- +
Link copied to clipboard
-
abstract fun timeSource(timeSource: TimeSource): Cache.Builder<K, V>

Specifies a TimeSource to be used for expiry checks. If not specified, TimeSource.Monotonic will be used.

+
abstract fun timeSource(timeSource: TimeSource): Cache.Builder<K, V>

Specifies a TimeSource to be used for expiry checks. If not specified, TimeSource.Monotonic will be used.

diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/maximum-cache-size.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/maximum-cache-size.html index 2d1f91d..32982b0 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/maximum-cache-size.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/maximum-cache-size.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/maximumCacheSize

maximumCacheSize

-
abstract fun maximumCacheSize(size: Long): Cache.Builder<K, V>

Specifies the maximum number of entries the cache may contain. Cache eviction policy is based on LRU - i.e. least recently accessed entries get evicted first.

When size is 0, entries will be discarded immediately and no values will be cached.

If not set, cache size will be unlimited.

+
abstract fun maximumCacheSize(size: Long): Cache.Builder<K, V>

Specifies the maximum number of entries the cache may contain. Cache eviction policy is based on LRU - i.e. least recently accessed entries get evicted first.

When size is 0, entries will be discarded immediately and no values will be cached.

If not set, cache size will be unlimited.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/time-source.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/time-source.html index 88aa906..00c52ac 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/time-source.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/-builder/time-source.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/Builder/timeSource

timeSource

-
abstract fun timeSource(timeSource: TimeSource): Cache.Builder<K, V>

Specifies a TimeSource to be used for expiry checks. If not specified, TimeSource.Monotonic will be used.

+
abstract fun timeSource(timeSource: TimeSource): Cache.Builder<K, V>

Specifies a TimeSource to be used for expiry checks. If not specified, TimeSource.Monotonic will be used.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/as-map.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/as-map.html index 75e78f3..31319d6 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/as-map.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/as-map.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/asMap

asMap

-
abstract fun asMap(): Map<in Key, Value>

Returns a defensive copy of cache entries as Map.

+
abstract fun asMap(): Map<in Key, Value>

Returns a defensive copy of cache entries as Map.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/get.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/get.html index a65e428..254f32b 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/get.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/get.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/get

get

-
abstract fun get(key: Key): Value?

Returns the value associated with key in this cache, or null if there is no cached value for key.

abstract suspend fun get(key: Key, loader: suspend () -> Value): Value

Returns the value associated with key in this cache if exists, otherwise gets the value by invoking loader, associates the value with key in the cache, and returns the cached value.

Any exceptions thrown by the loader will be propagated to the caller of this function.

+
abstract fun get(key: Key): Value?

Returns the value associated with key in this cache, or null if there is no cached value for key.

abstract suspend fun get(key: Key, loader: suspend () -> Value): Value

Returns the value associated with key in this cache if exists, otherwise gets the value by invoking loader, associates the value with key in the cache, and returns the cached value.

Any exceptions thrown by the loader will be propagated to the caller of this function.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/index.html index 2ac8692..8474628 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache

Cache

-
interface Cache<in Key : Any, Value : Any>

An in-memory key-value cache with support for time-based (expiration) and size-based evictions.

+
interface Cache<in Key : Any, Value : Any>

An in-memory key-value cache with support for time-based (expiration) and size-based evictions.

Types

-
-
+
+
- +
Link copied to clipboard
-
interface Builder<K : Any, V : Any>

Main entry point for creating a Cache.

+
interface Builder<K : Any, V : Any>

Main entry point for creating a Cache.

@@ -88,77 +88,77 @@

Types

Functions

-
-
+
+
- +
Link copied to clipboard
-
abstract fun asMap(): Map<in Key, Value>

Returns a defensive copy of cache entries as Map.

+
abstract fun asMap(): Map<in Key, Value>

Returns a defensive copy of cache entries as Map.

- -
+ +
- +
Link copied to clipboard
-
abstract fun get(key: Key): Value?

Returns the value associated with key in this cache, or null if there is no cached value for key.

abstract suspend fun get(key: Key, loader: suspend () -> Value): Value

Returns the value associated with key in this cache if exists, otherwise gets the value by invoking loader, associates the value with key in the cache, and returns the cached value.

+
abstract fun get(key: Key): Value?

Returns the value associated with key in this cache, or null if there is no cached value for key.

abstract suspend fun get(key: Key, loader: suspend () -> Value): Value

Returns the value associated with key in this cache if exists, otherwise gets the value by invoking loader, associates the value with key in the cache, and returns the cached value.

- -
+ +
- +
Link copied to clipboard
-
abstract fun invalidate(key: Key)

Discards any cached value for key key.

+
abstract fun invalidate(key: Key)

Discards any cached value for key key.

- -
+ +
- +
Link copied to clipboard
-
abstract fun invalidateAll()

Discards all entries in the cache.

+
abstract fun invalidateAll()

Discards all entries in the cache.

- -
+ +
- +
Link copied to clipboard
-
abstract fun put(key: Key, value: Value)

Associates value with key in this cache. If the cache previously contained a value associated with key, the old value is replaced by value.

+
abstract fun put(key: Key, value: Value)

Associates value with key in this cache. If the cache previously contained a value associated with key, the old value is replaced by value.

diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate-all.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate-all.html index b4bd9ad..31c56aa 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate-all.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate-all.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/invalidateAll

invalidateAll

-
abstract fun invalidateAll()

Discards all entries in the cache.

+
abstract fun invalidateAll()

Discards all entries in the cache.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate.html index 897d45d..0842a37 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/invalidate.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/invalidate

invalidate

-
abstract fun invalidate(key: Key)

Discards any cached value for key key.

+
abstract fun invalidate(key: Key)

Discards any cached value for key key.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-cache/put.html b/api/cache4k/io.github.reactivecircus.cache4k/-cache/put.html index eac9e6a..f5894e7 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-cache/put.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-cache/put.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/Cache/put

put

-
abstract fun put(key: Key, value: Value)

Associates value with key in this cache. If the cache previously contained a value associated with key, the old value is replaced by value.

+
abstract fun put(key: Key, value: Value)

Associates value with key in this cache. If the cache previously contained a value associated with key, the old value is replaced by value.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/-fake-time-source.html b/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/-fake-time-source.html index 23f3e52..a8cdf03 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/-fake-time-source.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/-fake-time-source.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/FakeTimeSource/FakeTimeSource

FakeTimeSource

-
constructor()
+
constructor()
© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/index.html b/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/index.html index 0733a21..c199a38 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/index.html @@ -45,7 +45,7 @@
- +
@@ -58,28 +58,28 @@
-
+
cache4k/io.github.reactivecircus.cache4k/FakeTimeSource

FakeTimeSource

-
class FakeTimeSource : AbstractLongTimeSource

A time source that has programmatically updatable readings with support for multi-threaded access in Kotlin/Native.

Implementation is identical to kotlin.time.TestTimeSource except the internal reading is an AtomicLong.

+
class FakeTimeSource : AbstractLongTimeSource

A time source that has programmatically updatable readings with support for multi-threaded access in Kotlin/Native.

Implementation is identical to kotlin.time.TestTimeSource except the internal reading is an AtomicLong.

Constructors

-
-
+
+
- +
Link copied to clipboard
-
constructor()
+
constructor()
@@ -88,32 +88,32 @@

Constructors

Functions

-
-
+
+
- - + +
Link copied to clipboard
-
open override fun markNow(): ComparableTimeMark
+
open override fun markNow(): ComparableTimeMark
- -
+ +
- +
Link copied to clipboard
-
operator fun plusAssign(duration: Duration)

Advances the current reading value of this time source by the specified duration.

+
operator fun plusAssign(duration: Duration)

Advances the current reading value of this time source by the specified duration.

diff --git a/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/plus-assign.html b/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/plus-assign.html index 4cded5b..b6ffa0a 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/plus-assign.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/-fake-time-source/plus-assign.html @@ -45,7 +45,7 @@
- +
@@ -58,12 +58,12 @@
-
+
cache4k/io.github.reactivecircus.cache4k/FakeTimeSource/plusAssign

plusAssign

-
operator fun plusAssign(duration: Duration)

Advances the current reading value of this time source by the specified duration.

duration value is rounded down towards zero when converting it to a Long number of nanoseconds. For example, if the duration being added is 0.6.nanoseconds, the reading doesn't advance because the duration value is rounded to zero nanoseconds.

Throws

when the reading value overflows as the result of this operation.

+
operator fun plusAssign(duration: Duration)

Advances the current reading value of this time source by the specified duration.

duration value is rounded down towards zero when converting it to a Long number of nanoseconds. For example, if the duration being added is 0.6.nanoseconds, the reading doesn't advance because the duration value is rounded to zero nanoseconds.

Throws

when the reading value overflows as the result of this operation.

© 2024 CopyrightGenerated by dokka diff --git a/api/cache4k/io.github.reactivecircus.cache4k/index.html b/api/cache4k/io.github.reactivecircus.cache4k/index.html index 3b892a6..94fcc98 100644 --- a/api/cache4k/io.github.reactivecircus.cache4k/index.html +++ b/api/cache4k/io.github.reactivecircus.cache4k/index.html @@ -45,7 +45,7 @@
- +
@@ -58,7 +58,7 @@
-
+
cache4k/io.github.reactivecircus.cache4k

Package-level declarations

@@ -68,62 +68,62 @@

Package-level declaratio

Types

-
-
+
+
- +
Link copied to clipboard
-
interface Cache<in Key : Any, Value : Any>

An in-memory key-value cache with support for time-based (expiration) and size-based evictions.

+
interface Cache<in Key : Any, Value : Any>

An in-memory key-value cache with support for time-based (expiration) and size-based evictions.

- -
+ +
- +
Link copied to clipboard
-
interface CacheEvent<Key : Any, Value : Any>

An event resulting from a mutative Cache operation.

+
interface CacheEvent<Key : Any, Value : Any>

An event resulting from a mutative Cache operation.

- -
+ +
- +
Link copied to clipboard
-
fun interface CacheEventListener<Key : Any, Value : Any>

Definition of the contract for implementing listeners to receive CacheEvents from a Cache.

+
fun interface CacheEventListener<Key : Any, Value : Any>

Definition of the contract for implementing listeners to receive CacheEvents from a Cache.

- -
+ +
- +
Link copied to clipboard
-
class FakeTimeSource : AbstractLongTimeSource

A time source that has programmatically updatable readings with support for multi-threaded access in Kotlin/Native.

+
class FakeTimeSource : AbstractLongTimeSource

A time source that has programmatically updatable readings with support for multi-threaded access in Kotlin/Native.

diff --git a/api/cache4k/navigation.html b/api/cache4k/navigation.html index 1df7e8b..3ca796b 100644 --- a/api/cache4k/navigation.html +++ b/api/cache4k/navigation.html @@ -1,63 +1,63 @@
-
+
cache4k
-
+
io.github.reactivecircus.cache4k
-
+
Cache
-
+ -
+
CacheEvent
-
+ -
+ -
+ -
+ - -
+ -
+
FakeTimeSource
diff --git a/api/navigation.html b/api/navigation.html index eb2d307..c988248 100644 --- a/api/navigation.html +++ b/api/navigation.html @@ -1,63 +1,63 @@
-
+
cache4k
-
+
io.github.reactivecircus.cache4k
-
+
Cache
-
+ -
+
CacheEvent
-
+ -
+ -
+ -
+ - -
+ -
+
FakeTimeSource
diff --git a/api/scripts/sourceset_dependencies.js b/api/scripts/sourceset_dependencies.js index e8866b7..c114951 100644 --- a/api/scripts/sourceset_dependencies.js +++ b/api/scripts/sourceset_dependencies.js @@ -1 +1 @@ -sourceset_dependencies = '{":cache4k:dokkaHtmlPartial/appleMain":[":cache4k:dokkaHtmlPartial/nativeMain",":cache4k:dokkaHtmlPartial/nonJvm"],":cache4k:dokkaHtmlPartial/commonMain":[],":cache4k:dokkaHtmlPartial/iosArm64Main":[":cache4k:dokkaHtmlPartial/iosMain"],":cache4k:dokkaHtmlPartial/iosMain":[":cache4k:dokkaHtmlPartial/appleMain",":cache4k:dokkaHtmlPartial/jvmAndIos"],":cache4k:dokkaHtmlPartial/iosSimulatorArm64Main":[":cache4k:dokkaHtmlPartial/iosMain"],":cache4k:dokkaHtmlPartial/iosX64Main":[":cache4k:dokkaHtmlPartial/iosMain"],":cache4k:dokkaHtmlPartial/jsMain":[":cache4k:dokkaHtmlPartial/commonMain",":cache4k:dokkaHtmlPartial/nonJvm"],":cache4k:dokkaHtmlPartial/jvmAndIos":[":cache4k:dokkaHtmlPartial/commonMain"],":cache4k:dokkaHtmlPartial/jvmMain":[":cache4k:dokkaHtmlPartial/commonMain",":cache4k:dokkaHtmlPartial/jvmAndIos"],":cache4k:dokkaHtmlPartial/linuxArm64Main":[":cache4k:dokkaHtmlPartial/linuxMain"],":cache4k:dokkaHtmlPartial/linuxMain":[":cache4k:dokkaHtmlPartial/nativeMain",":cache4k:dokkaHtmlPartial/nonJvm"],":cache4k:dokkaHtmlPartial/linuxX64Main":[":cache4k:dokkaHtmlPartial/linuxMain"],":cache4k:dokkaHtmlPartial/macosArm64Main":[":cache4k:dokkaHtmlPartial/macosMain"],":cache4k:dokkaHtmlPartial/macosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/macosX64Main":[":cache4k:dokkaHtmlPartial/macosMain"],":cache4k:dokkaHtmlPartial/mingwMain":[":cache4k:dokkaHtmlPartial/nativeMain",":cache4k:dokkaHtmlPartial/nonJvm"],":cache4k:dokkaHtmlPartial/mingwX64Main":[":cache4k:dokkaHtmlPartial/mingwMain"],":cache4k:dokkaHtmlPartial/nativeMain":[":cache4k:dokkaHtmlPartial/commonMain"],":cache4k:dokkaHtmlPartial/nonJvm":[":cache4k:dokkaHtmlPartial/commonMain"],":cache4k:dokkaHtmlPartial/tvosArm64Main":[":cache4k:dokkaHtmlPartial/tvosMain"],":cache4k:dokkaHtmlPartial/tvosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/tvosSimulatorArm64Main":[":cache4k:dokkaHtmlPartial/tvosMain"],":cache4k:dokkaHtmlPartial/tvosX64Main":[":cache4k:dokkaHtmlPartial/tvosMain"],":cache4k:dokkaHtmlPartial/wasmJsMain":[":cache4k:dokkaHtmlPartial/commonMain",":cache4k:dokkaHtmlPartial/nonJvm"],":cache4k:dokkaHtmlPartial/watchosArm64Main":[":cache4k:dokkaHtmlPartial/watchosMain"],":cache4k:dokkaHtmlPartial/watchosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/watchosSimulatorArm64Main":[":cache4k:dokkaHtmlPartial/watchosMain"],":cache4k:dokkaHtmlPartial/watchosX64Main":[":cache4k:dokkaHtmlPartial/watchosMain"]}' \ No newline at end of file +sourceset_dependencies = '{":cache4k:dokkaHtmlPartial/appleMain":[":cache4k:dokkaHtmlPartial/nativeMain",":cache4k:dokkaHtmlPartial/nonJvmMain"],":cache4k:dokkaHtmlPartial/commonMain":[],":cache4k:dokkaHtmlPartial/iosArm64Main":[":cache4k:dokkaHtmlPartial/iosMain"],":cache4k:dokkaHtmlPartial/iosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/iosSimulatorArm64Main":[":cache4k:dokkaHtmlPartial/iosMain"],":cache4k:dokkaHtmlPartial/iosX64Main":[":cache4k:dokkaHtmlPartial/iosMain"],":cache4k:dokkaHtmlPartial/jsMain":[":cache4k:dokkaHtmlPartial/commonMain",":cache4k:dokkaHtmlPartial/nonJvmMain"],":cache4k:dokkaHtmlPartial/jvmMain":[":cache4k:dokkaHtmlPartial/commonMain"],":cache4k:dokkaHtmlPartial/linuxArm64Main":[":cache4k:dokkaHtmlPartial/linuxMain"],":cache4k:dokkaHtmlPartial/linuxMain":[":cache4k:dokkaHtmlPartial/nativeMain",":cache4k:dokkaHtmlPartial/nonJvmMain"],":cache4k:dokkaHtmlPartial/linuxX64Main":[":cache4k:dokkaHtmlPartial/linuxMain"],":cache4k:dokkaHtmlPartial/macosArm64Main":[":cache4k:dokkaHtmlPartial/macosMain"],":cache4k:dokkaHtmlPartial/macosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/macosX64Main":[":cache4k:dokkaHtmlPartial/macosMain"],":cache4k:dokkaHtmlPartial/mingwMain":[":cache4k:dokkaHtmlPartial/nativeMain",":cache4k:dokkaHtmlPartial/nonJvmMain"],":cache4k:dokkaHtmlPartial/mingwX64Main":[":cache4k:dokkaHtmlPartial/mingwMain"],":cache4k:dokkaHtmlPartial/nativeMain":[":cache4k:dokkaHtmlPartial/commonMain"],":cache4k:dokkaHtmlPartial/nonJvmMain":[":cache4k:dokkaHtmlPartial/commonMain"],":cache4k:dokkaHtmlPartial/tvosArm64Main":[":cache4k:dokkaHtmlPartial/tvosMain"],":cache4k:dokkaHtmlPartial/tvosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/tvosSimulatorArm64Main":[":cache4k:dokkaHtmlPartial/tvosMain"],":cache4k:dokkaHtmlPartial/tvosX64Main":[":cache4k:dokkaHtmlPartial/tvosMain"],":cache4k:dokkaHtmlPartial/wasmJsMain":[":cache4k:dokkaHtmlPartial/commonMain",":cache4k:dokkaHtmlPartial/nonJvmMain"],":cache4k:dokkaHtmlPartial/watchosArm64Main":[":cache4k:dokkaHtmlPartial/watchosMain"],":cache4k:dokkaHtmlPartial/watchosMain":[":cache4k:dokkaHtmlPartial/appleMain"],":cache4k:dokkaHtmlPartial/watchosSimulatorArm64Main":[":cache4k:dokkaHtmlPartial/watchosMain"],":cache4k:dokkaHtmlPartial/watchosX64Main":[":cache4k:dokkaHtmlPartial/watchosMain"]}' \ No newline at end of file diff --git a/changelog/index.html b/changelog/index.html index 13f6008..aa9b629 100644 --- a/changelog/index.html +++ b/changelog/index.html @@ -1 +1 @@ - Change Log - cache4k

Change Log

0.12.0

Added

Added new targets: - linuxArm64

Changed

  • Kotlin 1.9.10
  • Coroutines 1.7.2
  • AtomicFU 0.21.0
  • Stately 2.0.5

0.11.0

Added

  • New event listener APIs (@darkxanter) - 35

Fixed

  • Downgrade stately to 1.2.5 to fix duplicate class error - 36

0.10.0

Added

Added new targets: - watchosArm64 - watchosSimulatorArm64 - watchosX64

FakeTimeSource is now public - #30

Changed

  • Kotlin 1.8.20.
  • AtomicFU 0.20.2.
  • Stately 2.0.0-rc1.

0.9.0

Fixed

  • Revert to using state-collections to fix JVM concurrency issue - #23

Changed

  • Kotlin 1.7.20.
  • AtomicFU 0.18.5.

0.8.0

Added

Added new targets: - linuxX64 - macosArm64

Changed

  • Kotlin 1.7.10.
  • Coroutines 1.6.4.
  • AtomicFU 0.18.3.

0.7.0

Changed

  • Kotlin 1.7.0.
  • Coroutines 1.6.3.
  • AtomicFU 0.18.2.

0.6.0

Changed

  • fakeTimeSource in Cache.Builder has been renamed to timeSource, and the FakeTimeSource implementation has been removed (still available in our tests) - #20
  • Kotlin 1.6.21.

0.5.0

This release adds support for new native memory model and drops support for the old one. Many thanks to @dcvz for the contribution.

Added

  • Synchronize cache loader by key - #15
  • Support new native memory model and drop support for old memory model - #17

Changed

  • Kotlin 1.6.20.
  • Coroutines 1.6.1.

0.4.0

Added

Added new targets: - iosSimulatorArm64 - macosArm64 - tvosArm64 - tvosSimulatorArm64 - tvosX64

Changed

  • Kotlin 1.6.10.
  • Stately 1.2.1.
  • Target Java 11.

0.3.0

Changed

  • Change fun newBuilder() to operator fun invoke() - #7.
  • Compile with Kotlin 1.5.21.

0.2.0

Changed

  • Support Kotlin 1.5.0.
  • Stately to 1.1.7.

0.1.1

Changed

  • Disable IR.

0.1.0

Initial release.

\ No newline at end of file + Change Log - cache4k

Change Log

0.13.0

Added

Added new targets: - wasmJs - #45

Changed

  • Switch internal map implementation to ConcurrentHashMap for JVM targets - #39
  • Kotlin 1.9.22
  • Coroutines 1.8.0
  • AtomicFU 0.23.2
  • Stately 2.0.6

0.12.0

Added

Added new targets: - linuxArm64

Changed

  • Kotlin 1.9.10
  • Coroutines 1.7.2
  • AtomicFU 0.21.0
  • Stately 2.0.5

0.11.0

Added

  • New event listener APIs (@darkxanter) - #35

Fixed

  • Downgrade stately to 1.2.5 to fix duplicate class error - #36

0.10.0

Added

Added new targets: - watchosArm64 - watchosSimulatorArm64 - watchosX64

FakeTimeSource is now public - #30

Changed

  • Kotlin 1.8.20.
  • AtomicFU 0.20.2.
  • Stately 2.0.0-rc1.

0.9.0

Fixed

  • Revert to using state-collections to fix JVM concurrency issue - #23

Changed

  • Kotlin 1.7.20.
  • AtomicFU 0.18.5.

0.8.0

Added

Added new targets: - linuxX64 - macosArm64

Changed

  • Kotlin 1.7.10.
  • Coroutines 1.6.4.
  • AtomicFU 0.18.3.

0.7.0

Changed

  • Kotlin 1.7.0.
  • Coroutines 1.6.3.
  • AtomicFU 0.18.2.

0.6.0

Changed

  • fakeTimeSource in Cache.Builder has been renamed to timeSource, and the FakeTimeSource implementation has been removed (still available in our tests) - #20
  • Kotlin 1.6.21.

0.5.0

This release adds support for new native memory model and drops support for the old one. Many thanks to @dcvz for the contribution.

Added

  • Synchronize cache loader by key - #15
  • Support new native memory model and drop support for old memory model - #17

Changed

  • Kotlin 1.6.20.
  • Coroutines 1.6.1.

0.4.0

Added

Added new targets: - iosSimulatorArm64 - macosArm64 - tvosArm64 - tvosSimulatorArm64 - tvosX64

Changed

  • Kotlin 1.6.10.
  • Stately 1.2.1.
  • Target Java 11.

0.3.0

Changed

  • Change fun newBuilder() to operator fun invoke() - #7.
  • Compile with Kotlin 1.5.21.

0.2.0

Changed

  • Support Kotlin 1.5.0.
  • Stately to 1.1.7.

0.1.1

Changed

  • Disable IR.

0.1.0

Initial release.

\ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json index b004405..1e9a115 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"cache4k","text":"

In-memory Cache for Kotlin Multiplatform.

Work in progress.

cache4k provides a simple in-memory key-value cache for Kotlin Multiplatform, with support for time-based (expiration) and size-based evictions.

Note that only the new Kotlin Native memory model is supported.

The following targets are currently supported:

  • jvm
  • js
  • wasmJs
  • iosX64
  • iosArm64
  • iosSimulatorArm64
  • macosX64
  • macosArm64
  • tvosX64
  • tvosArm64
  • tvosSimulatorArm64
  • watchosX64
  • watchosArm64
  • watchosSimulatorArm64
  • linuxX64
  • linuxArm64
  • mingwX64
"},{"location":"#download","title":"Download","text":"

Dependencies are hosted on Maven Central.

"},{"location":"#android","title":"Android","text":"
dependencies {\n    implementation(\"io.github.reactivecircus.cache4k:cache4k:x.y.z\")\n}\n
"},{"location":"#multiplatform","title":"Multiplatform","text":"
kotlin {\n    sourceSets {\n        commonMain {\n            dependencies {\n                implementation(\"io.github.reactivecircus.cache4k:cache4k:x.y.z\")\n            }\n        }\n    }\n}\n
"},{"location":"#usage","title":"Usage","text":""},{"location":"#writing-and-reading-cache-entries","title":"Writing and reading cache entries","text":"

To create a new Cache instance using Long for the key and String for the value:

val cache = Cache.Builder<Long, String>().build()\n

To start writing entries to the cache:

cache.put(1, \"dog\")\ncache.put(2, \"cat\")\n

To read a cache entry by key:

cache.get(1) // returns \"dog\"\ncache.get(2) // returns \"cat\"\ncache.get(3) // returns null\n

To overwrite an existing cache entry:

cache.put(1, \"dog\")\ncache.put(1, \"bird\")\ncache.get(1) // returns \"bird\"\n
"},{"location":"#cache-loader","title":"Cache loader","text":"

Cache provides an API for getting cached value by key and using the provided loader: suspend () -> Value lambda to compute and cache the value automatically if none exists.

runBlockingTest {\n    val cache = Cache.Builder<Long, User>().build()\n\n    val userId = 1L\n    val user = cache.get(userId) {\n        fetchUserById(userId) // potentially expensive call (might be a suspend function)\n    }\n\n    // value successfully computed by the loader will be cached automatically\n    assertThat(user).isEqualTo(cache.get(userId))\n}\n

Note that loader is executed on the caller\u2019s coroutine context. Concurrent calls from multiple threads using the same key will be blocked. Assuming the 1st call successfully computes a new value, none of the loader from the other calls will be executed and the cached value computed by the first loader will be returned for those calls.

Any exceptions thrown by the loader will be propagated to the caller of this function.

"},{"location":"#expirations-and-evictions","title":"Expirations and evictions","text":"

By default, Cache has an unlimited number of entries which never expire. But a cache can be configured to support both time-based expirations and size-based evictions.

"},{"location":"#time-based-expiration","title":"Time-based expiration","text":"

Expiration time can be specified for entries in the cache.

"},{"location":"#expire-after-access","title":"Expire after access","text":"

To set the maximum time an entry can live in the cache since the last access (also known as ** time-to-idle**), where \u201caccess\u201d means reading the cache, adding a new cache entry, or ** replacing an existing entry with a new one**:

val cache = Cache.Builder<Long, String>()\n    .expireAfterAccess(24.hours)\n    .build()\n

An entry in this cache will be removed if it has not been read or replaced after 24 hours since it\u2019s been written into the cache.

"},{"location":"#expire-after-write","title":"Expire after write","text":"

To set the maximum time an entry can live in the cache since the last write (also known as ** time-to-live**), where \u201cwrite\u201d means adding a new cache entry or replacing an existing entry with a new one:

val cache = Cache.Builder<Long, String>()\n    .expireAfterWrite(30.minutes)\n    .build()\n

An entry in this cache will be removed if it has not been replaced after 30 minutes since it\u2019s been written into the cache.

Note that cache entries are not removed immediately upon expiration at exact time. Expirations are checked in each interaction with the cache.

"},{"location":"#size-based-eviction","title":"Size-based eviction","text":"

To set the maximum number of entries to be kept in the cache:

val cache = Cache.Builder<Long, String>()\n    .maximumCacheSize(100)\n    .build()\n

Once there are more than 100 entries in this cache, the least recently used one will be removed, where \u201cused\u201d means reading the cache, adding a new cache entry, or replacing an existing entry with a new one.

"},{"location":"#getting-all-cache-entries-as-a-map","title":"Getting all cache entries as a Map","text":"

To get a copy of the current cache entries as a Map:

val cache = Cache.Builder<Long, String>()\n    .build()\n\ncache.put(1, \"dog\")\ncache.put(2, \"cat\")\n\nassertThat(cache.asMap())\n    .isEqualTo(mapOf(1L to \"dog\", 2L to \"cat\"))\n

Note that calling asMap() has no effect on the access expiry of the cache.

"},{"location":"#deleting-cache-entries","title":"Deleting cache entries","text":"

Cache entries can also be deleted explicitly.

To delete a cache entry for a given key:

val cache = Cache.Builder<Long, String>().build()\ncache.put(1, \"dog\")\n\ncache.invalidate(1)\n\nassertThat(cache.get(1)).isNull()\n

To delete all entries in the cache:

cache.invalidateAll()\n
"},{"location":"#event-listener","title":"Event listener","text":"

You can set an event listener as a lambda:

val cache1 = Cache.Builder<Long, String>()\n    .eventListener { event ->\n        println(\"onEvent: $event\")\n    }\n    .build()\n

Or declare it as a class and share logic across many stores:

class FileDeleteEventListener : CacheEventListener<Long, File> {\n    override fun onEvent(event: CacheEvent<Long, File>) {\n        when(event) {\n            is CacheEvent.Created -> {}\n            is CacheEvent.Updated -> event.oldValue.delete()\n            is CacheEvent.Evicted -> event.value.delete()\n            is CacheEvent.Expired -> event.value.delete()\n            is CacheEvent.Removed -> event.value.delete()\n        }\n    }\n}\nval fileDeleteEventListener = FileDeleteEventListener()\n\nval cache1 = Cache.Builder<Long, File>()\n    .eventListener(fileDeleteEventListener)\n    .build()\n\nval cache2 = Cache.Builder<Long, File>()\n    .eventListener(fileDeleteEventListener)\n    .build()\n

Cache entry event firing behaviors for mutative methods:

Initial value Operation New value Event {} put(K, V) {K: V} Created(K, V) {K: V1} put(K, V2) {K: V2} Updated(K, V1, V2) {K: V} invalidate(K) {} Removed(K, V) {K1: V1, K2: V2} invalidateAll() {} Removed(K1, V1), Removed(K2, V2) {K: V} any operation, K expired {} Expired(K, V) {K1: V1} put(K2, V2), K1 evicted {K2: V2} Created(K2, V2), Evicted(K1, V1)"},{"location":"#unit-testing-cache-expirations","title":"Unit testing cache expirations","text":"

To test logic that depends on cache expiration, pass in a FakeTimeSource when building a Cache so you can programmatically advance the reading of the time source:

@Test\nfun cacheEntryEvictedAfterExpiration() {\n    private val fakeTimeSource = FakeTimeSource()\n    val cache = Cache.Builder<Long, String>()\n        .timeSource(fakeTimeSource)\n        .expireAfterWrite(1.minutes)\n        .build()\n\n    cache.put(1, \"dog\")\n\n    // just before expiry\n    fakeTimeSource += 1.minutes - 1.nanoseconds\n\n    assertThat(cache.get(1))\n        .isEqualTo(\"dog\")\n\n    // now expires\n    fakeTimeSource += 1.nanoseconds\n\n    assertThat(cache.get(1))\n        .isNull()\n}\n
"},{"location":"#credits","title":"Credits","text":"

The library was ported from a kotlin / JVM cache which I contributed to dropbox/Store to help unblock Store\u2019s multiplatform support ( it was reverted before the 1.0 release as multiplatform wasn\u2019t a priority). Many thanks to Store\u2019s owners and contributors for reviewing and improving the original implementation.

"},{"location":"#license","title":"License","text":"
Copyright 2021 Yang Chen\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

"},{"location":"changelog/","title":"Change Log","text":""},{"location":"changelog/#0120","title":"0.12.0","text":""},{"location":"changelog/#added","title":"Added","text":"

Added new targets: - linuxArm64

"},{"location":"changelog/#changed","title":"Changed","text":"
  • Kotlin 1.9.10
  • Coroutines 1.7.2
  • AtomicFU 0.21.0
  • Stately 2.0.5
"},{"location":"changelog/#0110","title":"0.11.0","text":""},{"location":"changelog/#added_1","title":"Added","text":"
  • New event listener APIs (@darkxanter) - 35
"},{"location":"changelog/#fixed","title":"Fixed","text":"
  • Downgrade stately to 1.2.5 to fix duplicate class error - 36
"},{"location":"changelog/#0100","title":"0.10.0","text":""},{"location":"changelog/#added_2","title":"Added","text":"

Added new targets: - watchosArm64 - watchosSimulatorArm64 - watchosX64

FakeTimeSource is now public - #30

"},{"location":"changelog/#changed_1","title":"Changed","text":"
  • Kotlin 1.8.20.
  • AtomicFU 0.20.2.
  • Stately 2.0.0-rc1.
"},{"location":"changelog/#090","title":"0.9.0","text":""},{"location":"changelog/#fixed_1","title":"Fixed","text":"
  • Revert to using state-collections to fix JVM concurrency issue - #23
"},{"location":"changelog/#changed_2","title":"Changed","text":"
  • Kotlin 1.7.20.
  • AtomicFU 0.18.5.
"},{"location":"changelog/#080","title":"0.8.0","text":""},{"location":"changelog/#added_3","title":"Added","text":"

Added new targets: - linuxX64 - macosArm64

"},{"location":"changelog/#changed_3","title":"Changed","text":"
  • Kotlin 1.7.10.
  • Coroutines 1.6.4.
  • AtomicFU 0.18.3.
"},{"location":"changelog/#070","title":"0.7.0","text":""},{"location":"changelog/#changed_4","title":"Changed","text":"
  • Kotlin 1.7.0.
  • Coroutines 1.6.3.
  • AtomicFU 0.18.2.
"},{"location":"changelog/#060","title":"0.6.0","text":""},{"location":"changelog/#changed_5","title":"Changed","text":"
  • fakeTimeSource in Cache.Builder has been renamed to timeSource, and the FakeTimeSource implementation has been removed (still available in our tests) - #20
  • Kotlin 1.6.21.
"},{"location":"changelog/#050","title":"0.5.0","text":"

This release adds support for new native memory model and drops support for the old one. Many thanks to @dcvz for the contribution.

"},{"location":"changelog/#added_4","title":"Added","text":"
  • Synchronize cache loader by key - #15
  • Support new native memory model and drop support for old memory model - #17
"},{"location":"changelog/#changed_6","title":"Changed","text":"
  • Kotlin 1.6.20.
  • Coroutines 1.6.1.
"},{"location":"changelog/#040","title":"0.4.0","text":""},{"location":"changelog/#added_5","title":"Added","text":"

Added new targets: - iosSimulatorArm64 - macosArm64 - tvosArm64 - tvosSimulatorArm64 - tvosX64

"},{"location":"changelog/#changed_7","title":"Changed","text":"
  • Kotlin 1.6.10.
  • Stately 1.2.1.
  • Target Java 11.
"},{"location":"changelog/#030","title":"0.3.0","text":""},{"location":"changelog/#changed_8","title":"Changed","text":"
  • Change fun newBuilder() to operator fun invoke() - #7.
  • Compile with Kotlin 1.5.21.
"},{"location":"changelog/#020","title":"0.2.0","text":""},{"location":"changelog/#changed_9","title":"Changed","text":"
  • Support Kotlin 1.5.0.
  • Stately to 1.1.7.
"},{"location":"changelog/#011","title":"0.1.1","text":""},{"location":"changelog/#changed_10","title":"Changed","text":"
  • Disable IR.
"},{"location":"changelog/#010","title":"0.1.0","text":"

Initial release.

"}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"cache4k","text":"

In-memory Cache for Kotlin Multiplatform.

Work in progress.

cache4k provides a simple in-memory key-value cache for Kotlin Multiplatform, with support for time-based (expiration) and size-based evictions.

Note that only the new Kotlin Native memory model is supported.

The following targets are currently supported:

  • jvm
  • js
  • wasmJs
  • iosX64
  • iosArm64
  • iosSimulatorArm64
  • macosX64
  • macosArm64
  • tvosX64
  • tvosArm64
  • tvosSimulatorArm64
  • watchosX64
  • watchosArm64
  • watchosSimulatorArm64
  • linuxX64
  • linuxArm64
  • mingwX64
"},{"location":"#download","title":"Download","text":"

Dependencies are hosted on Maven Central.

"},{"location":"#android","title":"Android","text":"
dependencies {\n    implementation(\"io.github.reactivecircus.cache4k:cache4k:x.y.z\")\n}\n
"},{"location":"#multiplatform","title":"Multiplatform","text":"
kotlin {\n    sourceSets {\n        commonMain {\n            dependencies {\n                implementation(\"io.github.reactivecircus.cache4k:cache4k:x.y.z\")\n            }\n        }\n    }\n}\n
"},{"location":"#usage","title":"Usage","text":""},{"location":"#writing-and-reading-cache-entries","title":"Writing and reading cache entries","text":"

To create a new Cache instance using Long for the key and String for the value:

val cache = Cache.Builder<Long, String>().build()\n

To start writing entries to the cache:

cache.put(1, \"dog\")\ncache.put(2, \"cat\")\n

To read a cache entry by key:

cache.get(1) // returns \"dog\"\ncache.get(2) // returns \"cat\"\ncache.get(3) // returns null\n

To overwrite an existing cache entry:

cache.put(1, \"dog\")\ncache.put(1, \"bird\")\ncache.get(1) // returns \"bird\"\n
"},{"location":"#cache-loader","title":"Cache loader","text":"

Cache provides an API for getting cached value by key and using the provided loader: suspend () -> Value lambda to compute and cache the value automatically if none exists.

runBlockingTest {\n    val cache = Cache.Builder<Long, User>().build()\n\n    val userId = 1L\n    val user = cache.get(userId) {\n        fetchUserById(userId) // potentially expensive call (might be a suspend function)\n    }\n\n    // value successfully computed by the loader will be cached automatically\n    assertThat(user).isEqualTo(cache.get(userId))\n}\n

Note that loader is executed on the caller\u2019s coroutine context. Concurrent calls from multiple threads using the same key will be blocked. Assuming the 1st call successfully computes a new value, none of the loader from the other calls will be executed and the cached value computed by the first loader will be returned for those calls.

Any exceptions thrown by the loader will be propagated to the caller of this function.

"},{"location":"#expirations-and-evictions","title":"Expirations and evictions","text":"

By default, Cache has an unlimited number of entries which never expire. But a cache can be configured to support both time-based expirations and size-based evictions.

"},{"location":"#time-based-expiration","title":"Time-based expiration","text":"

Expiration time can be specified for entries in the cache.

"},{"location":"#expire-after-access","title":"Expire after access","text":"

To set the maximum time an entry can live in the cache since the last access (also known as ** time-to-idle**), where \u201caccess\u201d means reading the cache, adding a new cache entry, or ** replacing an existing entry with a new one**:

val cache = Cache.Builder<Long, String>()\n    .expireAfterAccess(24.hours)\n    .build()\n

An entry in this cache will be removed if it has not been read or replaced after 24 hours since it\u2019s been written into the cache.

"},{"location":"#expire-after-write","title":"Expire after write","text":"

To set the maximum time an entry can live in the cache since the last write (also known as ** time-to-live**), where \u201cwrite\u201d means adding a new cache entry or replacing an existing entry with a new one:

val cache = Cache.Builder<Long, String>()\n    .expireAfterWrite(30.minutes)\n    .build()\n

An entry in this cache will be removed if it has not been replaced after 30 minutes since it\u2019s been written into the cache.

Note that cache entries are not removed immediately upon expiration at exact time. Expirations are checked in each interaction with the cache.

"},{"location":"#size-based-eviction","title":"Size-based eviction","text":"

To set the maximum number of entries to be kept in the cache:

val cache = Cache.Builder<Long, String>()\n    .maximumCacheSize(100)\n    .build()\n

Once there are more than 100 entries in this cache, the least recently used one will be removed, where \u201cused\u201d means reading the cache, adding a new cache entry, or replacing an existing entry with a new one.

"},{"location":"#getting-all-cache-entries-as-a-map","title":"Getting all cache entries as a Map","text":"

To get a copy of the current cache entries as a Map:

val cache = Cache.Builder<Long, String>()\n    .build()\n\ncache.put(1, \"dog\")\ncache.put(2, \"cat\")\n\nassertThat(cache.asMap())\n    .isEqualTo(mapOf(1L to \"dog\", 2L to \"cat\"))\n

Note that calling asMap() has no effect on the access expiry of the cache.

"},{"location":"#deleting-cache-entries","title":"Deleting cache entries","text":"

Cache entries can also be deleted explicitly.

To delete a cache entry for a given key:

val cache = Cache.Builder<Long, String>().build()\ncache.put(1, \"dog\")\n\ncache.invalidate(1)\n\nassertThat(cache.get(1)).isNull()\n

To delete all entries in the cache:

cache.invalidateAll()\n
"},{"location":"#event-listener","title":"Event listener","text":"

You can set an event listener as a lambda:

val cache1 = Cache.Builder<Long, String>()\n    .eventListener { event ->\n        println(\"onEvent: $event\")\n    }\n    .build()\n

Or declare it as a class and share logic across many stores:

class FileDeleteEventListener : CacheEventListener<Long, File> {\n    override fun onEvent(event: CacheEvent<Long, File>) {\n        when(event) {\n            is CacheEvent.Created -> {}\n            is CacheEvent.Updated -> event.oldValue.delete()\n            is CacheEvent.Evicted -> event.value.delete()\n            is CacheEvent.Expired -> event.value.delete()\n            is CacheEvent.Removed -> event.value.delete()\n        }\n    }\n}\nval fileDeleteEventListener = FileDeleteEventListener()\n\nval cache1 = Cache.Builder<Long, File>()\n    .eventListener(fileDeleteEventListener)\n    .build()\n\nval cache2 = Cache.Builder<Long, File>()\n    .eventListener(fileDeleteEventListener)\n    .build()\n

Cache entry event firing behaviors for mutative methods:

Initial value Operation New value Event {} put(K, V) {K: V} Created(K, V) {K: V1} put(K, V2) {K: V2} Updated(K, V1, V2) {K: V} invalidate(K) {} Removed(K, V) {K1: V1, K2: V2} invalidateAll() {} Removed(K1, V1), Removed(K2, V2) {K: V} any operation, K expired {} Expired(K, V) {K1: V1} put(K2, V2), K1 evicted {K2: V2} Created(K2, V2), Evicted(K1, V1)"},{"location":"#unit-testing-cache-expirations","title":"Unit testing cache expirations","text":"

To test logic that depends on cache expiration, pass in a FakeTimeSource when building a Cache so you can programmatically advance the reading of the time source:

@Test\nfun cacheEntryEvictedAfterExpiration() {\n    private val fakeTimeSource = FakeTimeSource()\n    val cache = Cache.Builder<Long, String>()\n        .timeSource(fakeTimeSource)\n        .expireAfterWrite(1.minutes)\n        .build()\n\n    cache.put(1, \"dog\")\n\n    // just before expiry\n    fakeTimeSource += 1.minutes - 1.nanoseconds\n\n    assertThat(cache.get(1))\n        .isEqualTo(\"dog\")\n\n    // now expires\n    fakeTimeSource += 1.nanoseconds\n\n    assertThat(cache.get(1))\n        .isNull()\n}\n
"},{"location":"#credits","title":"Credits","text":"

The library was ported from a kotlin / JVM cache which I contributed to dropbox/Store to help unblock Store\u2019s multiplatform support ( it was reverted before the 1.0 release as multiplatform wasn\u2019t a priority). Many thanks to Store\u2019s owners and contributors for reviewing and improving the original implementation.

"},{"location":"#license","title":"License","text":"
Copyright 2021 Yang Chen\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

"},{"location":"changelog/","title":"Change Log","text":""},{"location":"changelog/#0130","title":"0.13.0","text":""},{"location":"changelog/#added","title":"Added","text":"

Added new targets: - wasmJs - #45

"},{"location":"changelog/#changed","title":"Changed","text":"
  • Switch internal map implementation to ConcurrentHashMap for JVM targets - #39
  • Kotlin 1.9.22
  • Coroutines 1.8.0
  • AtomicFU 0.23.2
  • Stately 2.0.6
"},{"location":"changelog/#0120","title":"0.12.0","text":""},{"location":"changelog/#added_1","title":"Added","text":"

Added new targets: - linuxArm64

"},{"location":"changelog/#changed_1","title":"Changed","text":"
  • Kotlin 1.9.10
  • Coroutines 1.7.2
  • AtomicFU 0.21.0
  • Stately 2.0.5
"},{"location":"changelog/#0110","title":"0.11.0","text":""},{"location":"changelog/#added_2","title":"Added","text":"
  • New event listener APIs (@darkxanter) - #35
"},{"location":"changelog/#fixed","title":"Fixed","text":"
  • Downgrade stately to 1.2.5 to fix duplicate class error - #36
"},{"location":"changelog/#0100","title":"0.10.0","text":""},{"location":"changelog/#added_3","title":"Added","text":"

Added new targets: - watchosArm64 - watchosSimulatorArm64 - watchosX64

FakeTimeSource is now public - #30

"},{"location":"changelog/#changed_2","title":"Changed","text":"
  • Kotlin 1.8.20.
  • AtomicFU 0.20.2.
  • Stately 2.0.0-rc1.
"},{"location":"changelog/#090","title":"0.9.0","text":""},{"location":"changelog/#fixed_1","title":"Fixed","text":"
  • Revert to using state-collections to fix JVM concurrency issue - #23
"},{"location":"changelog/#changed_3","title":"Changed","text":"
  • Kotlin 1.7.20.
  • AtomicFU 0.18.5.
"},{"location":"changelog/#080","title":"0.8.0","text":""},{"location":"changelog/#added_4","title":"Added","text":"

Added new targets: - linuxX64 - macosArm64

"},{"location":"changelog/#changed_4","title":"Changed","text":"
  • Kotlin 1.7.10.
  • Coroutines 1.6.4.
  • AtomicFU 0.18.3.
"},{"location":"changelog/#070","title":"0.7.0","text":""},{"location":"changelog/#changed_5","title":"Changed","text":"
  • Kotlin 1.7.0.
  • Coroutines 1.6.3.
  • AtomicFU 0.18.2.
"},{"location":"changelog/#060","title":"0.6.0","text":""},{"location":"changelog/#changed_6","title":"Changed","text":"
  • fakeTimeSource in Cache.Builder has been renamed to timeSource, and the FakeTimeSource implementation has been removed (still available in our tests) - #20
  • Kotlin 1.6.21.
"},{"location":"changelog/#050","title":"0.5.0","text":"

This release adds support for new native memory model and drops support for the old one. Many thanks to @dcvz for the contribution.

"},{"location":"changelog/#added_5","title":"Added","text":"
  • Synchronize cache loader by key - #15
  • Support new native memory model and drop support for old memory model - #17
"},{"location":"changelog/#changed_7","title":"Changed","text":"
  • Kotlin 1.6.20.
  • Coroutines 1.6.1.
"},{"location":"changelog/#040","title":"0.4.0","text":""},{"location":"changelog/#added_6","title":"Added","text":"

Added new targets: - iosSimulatorArm64 - macosArm64 - tvosArm64 - tvosSimulatorArm64 - tvosX64

"},{"location":"changelog/#changed_8","title":"Changed","text":"
  • Kotlin 1.6.10.
  • Stately 1.2.1.
  • Target Java 11.
"},{"location":"changelog/#030","title":"0.3.0","text":""},{"location":"changelog/#changed_9","title":"Changed","text":"
  • Change fun newBuilder() to operator fun invoke() - #7.
  • Compile with Kotlin 1.5.21.
"},{"location":"changelog/#020","title":"0.2.0","text":""},{"location":"changelog/#changed_10","title":"Changed","text":"
  • Support Kotlin 1.5.0.
  • Stately to 1.1.7.
"},{"location":"changelog/#011","title":"0.1.1","text":""},{"location":"changelog/#changed_11","title":"Changed","text":"
  • Disable IR.
"},{"location":"changelog/#010","title":"0.1.0","text":"

Initial release.

"}]} \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index a5f5695adfa3f051e47e0072318657042b444b62..4ede6cb6085e6896cb7542992257f51c5d87ca17 100644 GIT binary patch delta 14 VcmaFJ_>hrJzMF$%>4b@Fw*e(41uOsn delta 14 VcmaFJ_>hrJzMF&NP~}9n+W;k71u_5t