diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create-snapshot.md index 9f6d28c4..306745ff 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create-snapshot.md @@ -3,7 +3,7 @@ # createSnapshot [common]\ -abstract fun [createSnapshot](create-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md) +abstract fun [createSnapshot](create-snapshot.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md) Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. @@ -19,4 +19,4 @@ common | | | |---|---| -| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if serialized can't be deserialized | +| IllegalArgumentException | if serialized can't be deserialized | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create.md index c21fe2db..4a298c12 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/create.md @@ -3,7 +3,7 @@ # create [common]\ -abstract fun [create](create.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md) +abstract fun [create](create.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md) Creates entity cache-control @@ -19,4 +19,4 @@ common | | | |---|---| -| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if serialized can't be deserialized | +| IllegalArgumentException | if serialized can't be deserialized | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md index 76fe2bc8..86c34fda 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md @@ -11,8 +11,8 @@ Cache-control [EntityValidator](../-entity-validator/index.md) factory for opera | Name | Summary | |---|---| -| [create](create.md) | [common]
abstract fun [create](create.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md)
Creates entity cache-control | -| [createSnapshot](create-snapshot.md) | [common]
abstract fun [createSnapshot](create-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md)
Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. | +| [create](create.md) | [common]
abstract fun [create](create.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md)
Creates entity cache-control | +| [createSnapshot](create-snapshot.md) | [common]
abstract fun [createSnapshot](create-snapshot.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md)
Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. | ## Inheritors diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/deserialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/deserialize.md index 072422e7..bb04bbaa 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/deserialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/deserialize.md @@ -3,7 +3,7 @@ # deserialize [common]\ -open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)? +open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)? Deserializes validator from string if string is recognized diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/index.md index 5964aaff..7e3e9e1a 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/-always-deserializer/index.md @@ -11,5 +11,5 @@ Deserializes validator from string | Name | Summary | |---|---| -| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | -| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | +| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | +| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/index.md index 322d6b22..d2a6987e 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/index.md @@ -18,5 +18,5 @@ Entity that is always valid | Name | Summary | |---|---| | [createSnapshot](../create-snapshot.md) | [common]
open fun [createSnapshot](../create-snapshot.md)(): [EntityValidator](../index.md)
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value | -| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | +| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): Boolean
If true cached entity is valid. | +| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/is-valid.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/is-valid.md index df7c29cb..0ccac9f8 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/is-valid.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/is-valid.md @@ -3,6 +3,6 @@ # isValid [common]\ -open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override fun [isValid](is-valid.md)(): Boolean If true cached entity is valid. diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/serialize.md index 8be14be6..bb7120de 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-always/serialize.md @@ -3,6 +3,6 @@ # serialize [common]\ -open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +open override fun [serialize](serialize.md)(): String A way to serialize entity diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize-snapshot.md index 05e4430b..13ab4a22 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize-snapshot.md @@ -3,7 +3,7 @@ # deserializeSnapshot [common]\ -open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)? +open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../index.md)? Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../is-valid.md) with time diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize.md index cc7a0e4c..1b16c6af 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/deserialize.md @@ -3,7 +3,7 @@ # deserialize [common]\ -abstract fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)? +abstract fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../index.md)? Deserializes validator from string if string is recognized diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/index.md index c685a8c2..c6f5bc63 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-deserializer/index.md @@ -11,8 +11,8 @@ Deserializes validator from string | Name | Summary | |---|---| -| [deserialize](deserialize.md) | [common]
abstract fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)?
Deserializes validator from string if string is recognized | -| [deserializeSnapshot](deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../is-valid.md) with time | +| [deserialize](deserialize.md) | [common]
abstract fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../index.md)?
Deserializes validator from string if string is recognized | +| [deserializeSnapshot](deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../is-valid.md) with time | ## Inheritors diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/create-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/create-snapshot.md index 5c8f54be..7f0abad5 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/create-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/create-snapshot.md @@ -3,7 +3,7 @@ # createSnapshot [common]\ -fun [createSnapshot](create-snapshot.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md) +fun [createSnapshot](create-snapshot.md)(ttl: Long, clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md) Creates a snapshot that may be serialized and deserialized back to dynamic [Lifespan](../index.md) diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/index.md index 9cd50bb6..a5f735e4 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-companion/index.md @@ -9,4 +9,4 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [createSnapshot](create-snapshot.md) | [common]
fun [createSnapshot](create-snapshot.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md)
Creates a snapshot that may be serialized and deserialized back to dynamic [Lifespan](../index.md) | +| [createSnapshot](create-snapshot.md) | [common]
fun [createSnapshot](create-snapshot.md)(ttl: Long, clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md)
Creates a snapshot that may be serialized and deserialized back to dynamic [Lifespan](../index.md) | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize-snapshot.md index d5ff72cc..326fa1dd 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize-snapshot.md @@ -3,7 +3,7 @@ # deserializeSnapshot [common]\ -open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)? +open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)? Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize.md index 49f33d28..04f930c3 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/deserialize.md @@ -3,7 +3,7 @@ # deserialize [common]\ -open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)? +open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)? Deserializes validator from string if string is recognized diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/index.md index a61437ef..b7931998 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/index.md @@ -23,5 +23,5 @@ Deserializes validator from string | Name | Summary | |---|---| -| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | -| [deserializeSnapshot](deserialize-snapshot.md) | [common]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | +| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | +| [deserializeSnapshot](deserialize-snapshot.md) | [common]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan.md index 259134dc..a370d774 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan.md @@ -3,7 +3,7 @@ # Lifespan [common]\ -fun [Lifespan](-lifespan.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) +fun [Lifespan](-lifespan.md)(ttl: Long, clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) #### Parameters diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/equals.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/equals.md index 32a0d043..06362d03 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/equals.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/equals.md @@ -3,6 +3,6 @@ # equals [common]\ -open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open operator override fun [equals](equals.md)(other: Any?): Boolean As soon as we should provide [EntityValidator](../index.md) interface we compare only the commonMain property - validity - not the internal state diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/hash-code.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/hash-code.md index 5f2513d5..27f91ef5 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/hash-code.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/hash-code.md @@ -3,6 +3,6 @@ # hashCode [common]\ -open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +open override fun [hashCode](hash-code.md)(): Int As soon as we should provide [EntityValidator](../index.md) interface we calculate the commonMain property - validity - not the internal state diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/index.md index efa9e9ac..17c4c308 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/index.md @@ -21,7 +21,7 @@ common | | | |---|---| -| [Lifespan](-lifespan.md) | [common]
fun [Lifespan](-lifespan.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | +| [Lifespan](-lifespan.md) | [common]
fun [Lifespan](-lifespan.md)(ttl: Long, clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | ## Types @@ -35,8 +35,8 @@ common | Name | Summary | |---|---| | [createSnapshot](create-snapshot.md) | [common]
open override fun [createSnapshot](create-snapshot.md)(): [EntityValidator](../index.md)
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value | -| [equals](equals.md) | [common]
open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
As soon as we should provide [EntityValidator](../index.md) interface we compare only the commonMain property - validity - not the internal state | -| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
As soon as we should provide [EntityValidator](../index.md) interface we calculate the commonMain property - validity - not the internal state | -| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | -| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Display string | +| [equals](equals.md) | [common]
open operator override fun [equals](equals.md)(other: Any?): Boolean
As soon as we should provide [EntityValidator](../index.md) interface we compare only the commonMain property - validity - not the internal state | +| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): Int
As soon as we should provide [EntityValidator](../index.md) interface we calculate the commonMain property - validity - not the internal state | +| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): Boolean
If true cached entity is valid. | +| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | +| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): String
Display string | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/is-valid.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/is-valid.md index 726f9415..043da8d5 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/is-valid.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/is-valid.md @@ -3,6 +3,6 @@ # isValid [common]\ -open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override fun [isValid](is-valid.md)(): Boolean If true cached entity is valid. diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/serialize.md index f867c513..db3a1120 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/serialize.md @@ -3,6 +3,6 @@ # serialize [common]\ -open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +open override fun [serialize](serialize.md)(): String A way to serialize entity diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/to-string.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/to-string.md index 5a61fb3f..375d2b13 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/to-string.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/to-string.md @@ -3,6 +3,6 @@ # toString [common]\ -open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +open override fun [toString](to-string.md)(): String Display string diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/deserialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/deserialize.md index a7091168..8e7a3253 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/deserialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/deserialize.md @@ -3,7 +3,7 @@ # deserialize [common]\ -open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)? +open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)? Deserializes validator from string if string is recognized diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/index.md index 21a0b477..d68d8a45 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/-never-deserializer/index.md @@ -11,5 +11,5 @@ Deserializes validator from string | Name | Summary | |---|---| -| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | -| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | +| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | +| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/index.md index 4a2cd871..688d3618 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/index.md @@ -18,5 +18,5 @@ Entity that is never valid | Name | Summary | |---|---| | [createSnapshot](../create-snapshot.md) | [common]
open fun [createSnapshot](../create-snapshot.md)(): [EntityValidator](../index.md)
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value | -| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | +| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): Boolean
If true cached entity is valid. | +| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/is-valid.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/is-valid.md index 71176cf2..0d5e5a98 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/is-valid.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/is-valid.md @@ -3,6 +3,6 @@ # isValid [common]\ -open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override fun [isValid](is-valid.md)(): Boolean If true cached entity is valid. diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/serialize.md index 8fb6e6da..0c15ade7 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-never/serialize.md @@ -3,6 +3,6 @@ # serialize [common]\ -open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +open override fun [serialize](serialize.md)(): String A way to serialize entity diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/deserialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/deserialize.md index 05fc264e..09460ae9 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/deserialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/deserialize.md @@ -3,7 +3,7 @@ # deserialize [common]\ -open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)? +open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)? Deserializes validator from string if string is recognized diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/index.md index 2b4be7ea..e4718eaa 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple-deserializer/index.md @@ -11,5 +11,5 @@ Deserializes validator from string | Name | Summary | |---|---| -| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | -| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | +| [deserialize](deserialize.md) | [common]
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes validator from string if string is recognized | +| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]
open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?
Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple.md index a9d2cb78..f04f05ac 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/-simple.md @@ -3,7 +3,7 @@ # Simple [common]\ -fun [Simple](-simple.md)(valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) +fun [Simple](-simple.md)(valid: Boolean) #### Parameters diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/index.md index eee03082..0ab6dd96 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/index.md @@ -3,7 +3,7 @@ # Simple [common]\ -data class [Simple](index.md)(valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [EntityValidator](../index.md) +data class [Simple](index.md)(valid: Boolean) : [EntityValidator](../index.md) A simple validator which state is defined on creation May be used to fix the [isValid](is-valid.md) state of dynamic validator such as [Lifespan](../-lifespan/index.md) @@ -19,7 +19,7 @@ common | | | |---|---| -| [Simple](-simple.md) | [common]
fun [Simple](-simple.md)(valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +| [Simple](-simple.md) | [common]
fun [Simple](-simple.md)(valid: Boolean) | ## Types @@ -32,5 +32,5 @@ common | Name | Summary | |---|---| | [createSnapshot](../create-snapshot.md) | [common]
open fun [createSnapshot](../create-snapshot.md)(): [EntityValidator](../index.md)
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value | -| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | +| [isValid](is-valid.md) | [common]
open override fun [isValid](is-valid.md)(): Boolean
If true cached entity is valid. | +| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/is-valid.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/is-valid.md index 4e7a2671..bddecbfc 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/is-valid.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/is-valid.md @@ -3,6 +3,6 @@ # isValid [common]\ -open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override fun [isValid](is-valid.md)(): Boolean If true cached entity is valid. diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/serialize.md index dd978181..c071a961 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-simple/serialize.md @@ -3,6 +3,6 @@ # serialize [common]\ -open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +open override fun [serialize](serialize.md)(): String A way to serialize entity diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/index.md index b3cde634..0d429d74 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/index.md @@ -15,15 +15,15 @@ Entity validator | [Deserializer](-deserializer/index.md) | [common]
interface [Deserializer](-deserializer/index.md)
Deserializes validator from string | | [Lifespan](-lifespan/index.md) | [common]
class [Lifespan](-lifespan/index.md) : [EntityValidator](index.md)
Uses creation time and TTL to validate | | [Never](-never/index.md) | [common]
object [Never](-never/index.md) : [EntityValidator](index.md)
Entity that is never valid | -| [Simple](-simple/index.md) | [common]
data class [Simple](-simple/index.md)(valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [EntityValidator](index.md)
A simple validator which state is defined on creation May be used to fix the [isValid](-simple/is-valid.md) state of dynamic validator such as [Lifespan](-lifespan/index.md) | +| [Simple](-simple/index.md) | [common]
data class [Simple](-simple/index.md)(valid: Boolean) : [EntityValidator](index.md)
A simple validator which state is defined on creation May be used to fix the [isValid](-simple/is-valid.md) state of dynamic validator such as [Lifespan](-lifespan/index.md) | ## Functions | Name | Summary | |---|---| | [createSnapshot](create-snapshot.md) | [common]
open fun [createSnapshot](create-snapshot.md)(): [EntityValidator](index.md)
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](is-valid.md) value | -| [isValid](is-valid.md) | [common]
abstract fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
abstract fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | +| [isValid](is-valid.md) | [common]
abstract fun [isValid](is-valid.md)(): Boolean
If true cached entity is valid. | +| [serialize](serialize.md) | [common]
abstract fun [serialize](serialize.md)(): String
A way to serialize entity | ## Inheritors diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/is-valid.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/is-valid.md index 1e45a7ea..3496905f 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/is-valid.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/is-valid.md @@ -3,6 +3,6 @@ # isValid [common]\ -abstract fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +abstract fun [isValid](is-valid.md)(): Boolean If true cached entity is valid. diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/serialize.md index c50f61f2..f0f7f959 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/serialize.md @@ -3,6 +3,6 @@ # serialize [common]\ -abstract fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +abstract fun [serialize](serialize.md)(): String A way to serialize entity diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/-impl.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/-impl.md index 94f65b3c..55511ac2 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/-impl.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/-impl.md @@ -3,7 +3,7 @@ # Impl [common]\ -fun <out [T](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Impl](-impl.md)(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) +fun <out [T](index.md) : Any> [Impl](-impl.md)(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) #### Parameters diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/index.md index 612e0fae..9ca38e97 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/index.md @@ -3,7 +3,7 @@ # Impl [common]\ -data class [Impl](index.md)<out [T](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) : [Entity](../index.md)<[T](index.md)> , [EntityValidator](../../-entity-validator/index.md) +data class [Impl](index.md)<out [T](index.md) : Any>(val data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) : [Entity](../index.md)<[T](index.md)> , [EntityValidator](../../-entity-validator/index.md) Simple entity implementation @@ -20,16 +20,16 @@ common | | | |---|---| -| [Impl](-impl.md) | [common]
fun <out [T](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Impl](-impl.md)(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) | +| [Impl](-impl.md) | [common]
fun <out [T](index.md) : Any> [Impl](-impl.md)(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) | ## Functions | Name | Summary | |---|---| | [createSnapshot](create-snapshot.md) | [common]
open override fun [createSnapshot](create-snapshot.md)(): [Entity](../index.md)<[T](index.md)>
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../../-entity-validator/is-valid.md) value | -| [isValid](../../-entity-validator/is-valid.md) | [common]
open override fun [isValid](../../-entity-validator/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [map](map.md) | [common]
open override fun <[R](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](../index.md)<[R](map.md)>
Transforms Entity [data](data.md) to another entity data with [mapper](map.md) Validation remains the same | -| [serialize](../../-entity-validator/serialize.md) | [common]
open override fun [serialize](../../-entity-validator/serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | +| [isValid](../../-entity-validator/is-valid.md) | [common]
open override fun [isValid](../../-entity-validator/is-valid.md)(): Boolean
If true cached entity is valid. | +| [map](map.md) | [common]
open override fun <[R](map.md) : Any> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](../index.md)<[R](map.md)>
Transforms Entity [data](data.md) to another entity data with [mapper](map.md) Validation remains the same | +| [serialize](../../-entity-validator/serialize.md) | [common]
open override fun [serialize](../../-entity-validator/serialize.md)(): String
A way to serialize entity | ## Properties diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/map.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/map.md index 62b6f1b8..86ef59b6 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/map.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/map.md @@ -3,6 +3,6 @@ # map [common]\ -open override fun <[R](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](../index.md)<[R](map.md)> +open override fun <[R](map.md) : Any> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](../index.md)<[R](map.md)> Transforms Entity [data](data.md) to another entity data with [mapper](map.md) Validation remains the same diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md index 38376eba..3963847e 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md @@ -3,7 +3,7 @@ # Entity [common]\ -interface [Entity](index.md)<out [T](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [EntityValidator](../-entity-validator/index.md) +interface [Entity](index.md)<out [T](index.md) : Any> : [EntityValidator](../-entity-validator/index.md) Cache-controlling entity for [com.motorro.rxlcemodel.cache.entity.Entity](index.md) implement this interface for cache control @@ -11,16 +11,16 @@ Cache-controlling entity for [com.motorro.rxlcemodel.cache.entity.Entity](index. | Name | Summary | |---|---| -| [Impl](-impl/index.md) | [common]
data class [Impl](-impl/index.md)<out [T](-impl/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [T](-impl/index.md), validator: [EntityValidator](../-entity-validator/index.md)) : [Entity](index.md)<[T](-impl/index.md)> , [EntityValidator](../-entity-validator/index.md)
Simple entity implementation | +| [Impl](-impl/index.md) | [common]
data class [Impl](-impl/index.md)<out [T](-impl/index.md) : Any>(val data: [T](-impl/index.md), validator: [EntityValidator](../-entity-validator/index.md)) : [Entity](index.md)<[T](-impl/index.md)> , [EntityValidator](../-entity-validator/index.md)
Simple entity implementation | ## Functions | Name | Summary | |---|---| | [createSnapshot](create-snapshot.md) | [common]
abstract override fun [createSnapshot](create-snapshot.md)(): [Entity](index.md)<[T](index.md)>
Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../-entity-validator/is-valid.md) value | -| [isValid](../-entity-validator/is-valid.md) | [common]
abstract fun [isValid](../-entity-validator/is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
If true cached entity is valid. | -| [map](map.md) | [common]
abstract fun <[R](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](index.md)<[R](map.md)>
Transforms Entity [data](data.md) to another entity data with [mapper](map.md) Validation remains the same | -| [serialize](../-entity-validator/serialize.md) | [common]
abstract fun [serialize](../-entity-validator/serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A way to serialize entity | +| [isValid](../-entity-validator/is-valid.md) | [common]
abstract fun [isValid](../-entity-validator/is-valid.md)(): Boolean
If true cached entity is valid. | +| [map](map.md) | [common]
abstract fun <[R](map.md) : Any> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](index.md)<[R](map.md)>
Transforms Entity [data](data.md) to another entity data with [mapper](map.md) Validation remains the same | +| [serialize](../-entity-validator/serialize.md) | [common]
abstract fun [serialize](../-entity-validator/serialize.md)(): String
A way to serialize entity | ## Properties diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/map.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/map.md index 6eb617ed..ea2aacbc 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/map.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/map.md @@ -3,6 +3,6 @@ # map [common]\ -abstract fun <[R](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](index.md)<[R](map.md)> +abstract fun <[R](map.md) : Any> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](index.md)<[R](map.md)> Transforms Entity [data](data.md) to another entity data with [mapper](map.md) Validation remains the same diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/-lifespan-validator-factory.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/-lifespan-validator-factory.md index ba37fc46..656c838c 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/-lifespan-validator-factory.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/-lifespan-validator-factory.md @@ -3,7 +3,7 @@ # LifespanValidatorFactory [common]\ -fun [LifespanValidatorFactory](-lifespan-validator-factory.md)(cacheTtl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) +fun [LifespanValidatorFactory](-lifespan-validator-factory.md)(cacheTtl: Long, clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) #### Parameters diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create-snapshot.md index 0c40c25a..e98701e1 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create-snapshot.md @@ -3,7 +3,7 @@ # createSnapshot [common]\ -open override fun [createSnapshot](create-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?): [EntityValidator](../-entity-validator/index.md) +open override fun [createSnapshot](create-snapshot.md)(serialized: String?): [EntityValidator](../-entity-validator/index.md) Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. @@ -19,4 +19,4 @@ common | | | |---|---| -| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if serialized can't be deserialized | +| IllegalArgumentException | if serialized can't be deserialized | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create.md index 926c561c..e0a5bf79 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/create.md @@ -3,7 +3,7 @@ # create [common]\ -open override fun [create](create.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?): [EntityValidator](../-entity-validator/index.md) +open override fun [create](create.md)(serialized: String?): [EntityValidator](../-entity-validator/index.md) Creates entity cache-control @@ -19,4 +19,4 @@ common | | | |---|---| -| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if serialized can't be deserialized | +| IllegalArgumentException | if serialized can't be deserialized | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/index.md index 42d4bc44..318df78b 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-lifespan-validator-factory/index.md @@ -3,7 +3,7 @@ # LifespanValidatorFactory [common]\ -class [LifespanValidatorFactory](index.md)(cacheTtl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [EntityValidatorFactory](../-entity-validator-factory/index.md) +class [LifespanValidatorFactory](index.md)(cacheTtl: Long, clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [EntityValidatorFactory](../-entity-validator-factory/index.md) Creates [Lifespan](../-entity-validator/-lifespan/index.md) as a cache-control @@ -20,11 +20,11 @@ common | | | |---|---| -| [LifespanValidatorFactory](-lifespan-validator-factory.md) | [common]
fun [LifespanValidatorFactory](-lifespan-validator-factory.md)(cacheTtl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | +| [LifespanValidatorFactory](-lifespan-validator-factory.md) | [common]
fun [LifespanValidatorFactory](-lifespan-validator-factory.md)(cacheTtl: Long, clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | ## Functions | Name | Summary | |---|---| -| [create](create.md) | [common]
open override fun [create](create.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?): [EntityValidator](../-entity-validator/index.md)
Creates entity cache-control | -| [createSnapshot](create-snapshot.md) | [common]
open override fun [createSnapshot](create-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)?): [EntityValidator](../-entity-validator/index.md)
Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. | +| [create](create.md) | [common]
open override fun [create](create.md)(serialized: String?): [EntityValidator](../-entity-validator/index.md)
Creates entity cache-control | +| [createSnapshot](create-snapshot.md) | [common]
open override fun [createSnapshot](create-snapshot.md)(serialized: String?): [EntityValidator](../-entity-validator/index.md)
Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/index.md index 49a95fc4..eb7f79a4 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/index.md @@ -6,13 +6,13 @@ | Name | Summary | |---|---| -| [Entity](-entity/index.md) | [common]
interface [Entity](-entity/index.md)<out [T](-entity/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [EntityValidator](-entity-validator/index.md)
Cache-controlling entity for [com.motorro.rxlcemodel.cache.entity.Entity](-entity/index.md) implement this interface for cache control | +| [Entity](-entity/index.md) | [common]
interface [Entity](-entity/index.md)<out [T](-entity/index.md) : Any> : [EntityValidator](-entity-validator/index.md)
Cache-controlling entity for [com.motorro.rxlcemodel.cache.entity.Entity](-entity/index.md) implement this interface for cache control | | [EntityValidator](-entity-validator/index.md) | [common]
interface [EntityValidator](-entity-validator/index.md)
Entity validator | | [EntityValidatorFactory](-entity-validator-factory/index.md) | [common]
interface [EntityValidatorFactory](-entity-validator-factory/index.md)
Cache-control [EntityValidator](-entity-validator/index.md) factory for operations | -| [LifespanValidatorFactory](-lifespan-validator-factory/index.md) | [common]
class [LifespanValidatorFactory](-lifespan-validator-factory/index.md)(cacheTtl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [EntityValidatorFactory](-entity-validator-factory/index.md)
Creates [Lifespan](-entity-validator/-lifespan/index.md) as a cache-control | +| [LifespanValidatorFactory](-lifespan-validator-factory/index.md) | [common]
class [LifespanValidatorFactory](-lifespan-validator-factory/index.md)(cacheTtl: Long, clock: [Clock](../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [EntityValidatorFactory](-entity-validator-factory/index.md)
Creates [Lifespan](-entity-validator/-lifespan/index.md) as a cache-control | ## Functions | Name | Summary | |---|---| -| [toEntity](to-entity.md) | [common]
fun <[T](to-entity.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [T](to-entity.md).[toEntity](to-entity.md)(validator: [EntityValidator](-entity-validator/index.md)): [Entity.Impl](-entity/-impl/index.md)<[T](to-entity.md)>
Converts [T](to-entity.md) to [Entity](-entity/index.md) to use with services | +| [toEntity](to-entity.md) | [common]
fun <[T](to-entity.md) : Any> [T](to-entity.md).[toEntity](to-entity.md)(validator: [EntityValidator](-entity-validator/index.md)): [Entity.Impl](-entity/-impl/index.md)<[T](to-entity.md)>
Converts [T](to-entity.md) to [Entity](-entity/index.md) to use with services | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/to-entity.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/to-entity.md index 230b35a2..ffe65b44 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/to-entity.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/to-entity.md @@ -3,7 +3,7 @@ # toEntity [common]\ -fun <[T](to-entity.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [T](to-entity.md).[toEntity](to-entity.md)(validator: [EntityValidator](-entity-validator/index.md)): [Entity.Impl](-entity/-impl/index.md)<[T](to-entity.md)> +fun <[T](to-entity.md) : Any> [T](to-entity.md).[toEntity](to-entity.md)(validator: [EntityValidator](-entity-validator/index.md)): [Entity.Impl](-entity/-impl/index.md)<[T](to-entity.md)> Converts [T](to-entity.md) to [Entity](-entity/index.md) to use with services diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/deserialize-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/deserialize-snapshot.md index 1d46eea2..ddd87dc6 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/deserialize-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/deserialize-snapshot.md @@ -3,7 +3,7 @@ # deserializeSnapshot [jvm]\ -open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>? +open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>? Deserializes [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/index.md index 8ab6e329..5183ae4b 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/index.md @@ -26,5 +26,5 @@ jvm | Name | Summary | |---|---| -| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream | +| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream | | [serialize](serialize.md) | [jvm]
open override fun [serialize](serialize.md)(entity: [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>, output: [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html))
Serializes [entity](serialize.md) to [output](serialize.md) stream | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/deserialize-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/deserialize-snapshot.md index 1b4b49c8..d9b3cc0e 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/deserialize-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/deserialize-snapshot.md @@ -3,7 +3,7 @@ # deserializeSnapshot [jvm]\ -abstract fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>? +abstract fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>? Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) snapshot from [input](deserialize-snapshot.md) stream Snapshots are used because the validity status is only actual when we are getting cached data. https://github.com/motorro/RxLceModel/issues/5 diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md index d46059da..47d51f40 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md @@ -3,7 +3,7 @@ # CacheDelegateSerializerDeserializer [jvm]\ -interface [CacheDelegateSerializerDeserializer](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> +interface [CacheDelegateSerializerDeserializer](index.md)<[D](index.md) : Any> Serializer for cache delegates @@ -17,7 +17,7 @@ Serializer for cache delegates | Name | Summary | |---|---| -| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
abstract fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) snapshot from [input](deserialize-snapshot.md) stream Snapshots are used because the validity status is only actual when we are getting cached data. https://github.com/motorro/RxLceModel/issues/5 | +| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
abstract fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) snapshot from [input](deserialize-snapshot.md) stream Snapshots are used because the validity status is only actual when we are getting cached data. https://github.com/motorro/RxLceModel/issues/5 | | [serialize](serialize.md) | [jvm]
abstract fun [serialize](serialize.md)(entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>, output: [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html))
Serializes [entity](serialize.md) to [output](serialize.md) stream | ## Inheritors diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md index 5dcde4c6..22cd2bd2 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md @@ -3,7 +3,7 @@ # CacheDelegate [common]\ -interface [CacheDelegate](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> +interface [CacheDelegate](index.md)<[D](index.md) : Any, [P](index.md) : Any> Delegate that synchronously performs caching operations @@ -28,5 +28,5 @@ Delegate that synchronously performs caching operations | Name | Summary | |---|---| -| [makeFriendParams](../make-friend-params.md) | [common]
inline fun <[D](../make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](index.md)<[D](../make-friend-params.md), [CacheFriend](../-cache-friend/index.md)>.[makeFriendParams](../make-friend-params.md)(crossinline stringify: [P](../make-friend-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](index.md)<[D](../make-friend-params.md), [P](../make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](../-cache-friend/index.md) params using [stringify](../make-friend-params.md) function | -| [stringifyParams](../stringify-params.md) | [common]
inline fun <[D](../stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](index.md)<[D](../stringify-params.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>.[stringifyParams](../stringify-params.md)(crossinline stringify: [P](../stringify-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = { toString() }): [CacheDelegate](index.md)<[D](../stringify-params.md), [P](../stringify-params.md)>
Creates an adapter delegate that [stringify](../stringify-params.md) and uses result string as params to receiver | +| [makeFriendParams](../make-friend-params.md) | [common]
inline fun <[D](../make-friend-params.md) : Any, [P](../make-friend-params.md) : Any> [CacheDelegate](index.md)<[D](../make-friend-params.md), [CacheFriend](../-cache-friend/index.md)>.[makeFriendParams](../make-friend-params.md)(crossinline stringify: [P](../make-friend-params.md).() -> String): [CacheDelegate](index.md)<[D](../make-friend-params.md), [P](../make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](../-cache-friend/index.md) params using [stringify](../make-friend-params.md) function | +| [stringifyParams](../stringify-params.md) | [common]
inline fun <[D](../stringify-params.md) : Any, [P](../stringify-params.md) : Any> [CacheDelegate](index.md)<[D](../stringify-params.md), String>.[stringifyParams](../stringify-params.md)(crossinline stringify: [P](../stringify-params.md).() -> String = { toString() }): [CacheDelegate](index.md)<[D](../stringify-params.md), [P](../stringify-params.md)>
Creates an adapter delegate that [stringify](../stringify-params.md) and uses result string as params to receiver | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/-cache-friend-delegate.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/-cache-friend-delegate.md index 61811d5e..5f2bb416 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/-cache-friend-delegate.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/-cache-friend-delegate.md @@ -3,4 +3,4 @@ # CacheFriendDelegate [common]\ -fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](index.md) : [CacheFriend](../-cache-friend/index.md)> [CacheFriendDelegate](-cache-friend-delegate.md)(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) +fun <[D](index.md) : Any, [P](index.md) : [CacheFriend](../-cache-friend/index.md)> [CacheFriendDelegate](-cache-friend-delegate.md)(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/index.md index d20a2aea..82834255 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/index.md @@ -3,7 +3,7 @@ # CacheFriendDelegate [common]\ -class [CacheFriendDelegate](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](index.md) : [CacheFriend](../-cache-friend/index.md)>(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) : [CacheDelegate](../-cache-delegate/index.md)<[D](index.md), [P](index.md)> +class [CacheFriendDelegate](index.md)<[D](index.md) : Any, [P](index.md) : [CacheFriend](../-cache-friend/index.md)>(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) : [CacheDelegate](../-cache-delegate/index.md)<[D](index.md), [P](index.md)> Wraps [delegate](../../../../cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/delegate.md) adding unmodified [CacheFriend.cacheKey](../-cache-friend/cache-key.md) to the mix with data. Validates that key on [get](get.md) and returns null if it is not equals original. Helps to make sure the data returned is not a result of clashed cache key. @@ -11,7 +11,7 @@ Wraps [delegate](../../../../cache/com.motorro.rxlcemodel.cache/-cache-friend-de | | | |---|---| -| [CacheFriendDelegate](-cache-friend-delegate.md) | [common]
fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](index.md) : [CacheFriend](../-cache-friend/index.md)> [CacheFriendDelegate](-cache-friend-delegate.md)(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) | +| [CacheFriendDelegate](-cache-friend-delegate.md) | [common]
fun <[D](index.md) : Any, [P](index.md) : [CacheFriend](../-cache-friend/index.md)> [CacheFriendDelegate](-cache-friend-delegate.md)(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) | ## Functions @@ -27,5 +27,5 @@ Wraps [delegate](../../../../cache/com.motorro.rxlcemodel.cache/-cache-friend-de | Name | Summary | |---|---| -| [makeFriendParams](../make-friend-params.md) | [common]
inline fun <[D](../make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [CacheFriend](../-cache-friend/index.md)>.[makeFriendParams](../make-friend-params.md)(crossinline stringify: [P](../make-friend-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [P](../make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](../-cache-friend/index.md) params using [stringify](../make-friend-params.md) function | -| [stringifyParams](../stringify-params.md) | [common]
inline fun <[D](../stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>.[stringifyParams](../stringify-params.md)(crossinline stringify: [P](../stringify-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = { toString() }): [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), [P](../stringify-params.md)>
Creates an adapter delegate that [stringify](../stringify-params.md) and uses result string as params to receiver | +| [makeFriendParams](../make-friend-params.md) | [common]
inline fun <[D](../make-friend-params.md) : Any, [P](../make-friend-params.md) : Any> [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [CacheFriend](../-cache-friend/index.md)>.[makeFriendParams](../make-friend-params.md)(crossinline stringify: [P](../make-friend-params.md).() -> String): [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [P](../make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](../-cache-friend/index.md) params using [stringify](../make-friend-params.md) function | +| [stringifyParams](../stringify-params.md) | [common]
inline fun <[D](../stringify-params.md) : Any, [P](../stringify-params.md) : Any> [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), String>.[stringifyParams](../stringify-params.md)(crossinline stringify: [P](../stringify-params.md).() -> String = { toString() }): [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), [P](../stringify-params.md)>
Creates an adapter delegate that [stringify](../stringify-params.md) and uses result string as params to receiver | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/cache-key.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/cache-key.md index 5c8b8940..bdf76cc2 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/cache-key.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/cache-key.md @@ -3,6 +3,6 @@ # cacheKey [common]\ -open val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +open val [cacheKey](cache-key.md): String A cache key diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md index 497fe8b5..37dd1fa4 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md @@ -11,4 +11,4 @@ Generates a cache-friendly key value for parameters | Name | Summary | |---|---| -| [cacheKey](cache-key.md) | [common]
open val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
A cache key | +| [cacheKey](cache-key.md) | [common]
open val [cacheKey](cache-key.md): String
A cache key | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/-data-with-cache-key.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/-data-with-cache-key.md index df9bac6f..bbef2696 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/-data-with-cache-key.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/-data-with-cache-key.md @@ -3,7 +3,7 @@ # DataWithCacheKey [common]\ -fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DataWithCacheKey](-data-with-cache-key.md)(data: [D](index.md), cacheKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) +fun <[D](index.md) : Any> [DataWithCacheKey](-data-with-cache-key.md)(data: [D](index.md), cacheKey: String) #### Parameters diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/cache-key.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/cache-key.md index c4313561..e300f6f4 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/cache-key.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/cache-key.md @@ -3,7 +3,7 @@ # cacheKey [common]\ -val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) +val [cacheKey](cache-key.md): String #### Parameters diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md index 299edcb5..1856e717 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md @@ -3,7 +3,7 @@ # DataWithCacheKey [common]\ -data class [DataWithCacheKey](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [D](index.md), val cacheKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) +data class [DataWithCacheKey](index.md)<[D](index.md) : Any>(val data: [D](index.md), val cacheKey: String) Data combined with full cached key to validate we get exactly what we are looking for For example, DiskLruCache has strict requirements and limited length of a cache key and hashing of keys may be required to fit into requirements - thus there is a possibility of key clash. @@ -28,11 +28,11 @@ common | | | |---|---| -| [DataWithCacheKey](-data-with-cache-key.md) | [common]
fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DataWithCacheKey](-data-with-cache-key.md)(data: [D](index.md), cacheKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | +| [DataWithCacheKey](-data-with-cache-key.md) | [common]
fun <[D](index.md) : Any> [DataWithCacheKey](-data-with-cache-key.md)(data: [D](index.md), cacheKey: String) | ## Properties | Name | Summary | |---|---| -| [cacheKey](cache-key.md) | [common]
val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [cacheKey](cache-key.md) | [common]
val [cacheKey](cache-key.md): String | | [data](data.md) | [common]
val [data](data.md): [D](index.md) | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/create.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/create.md index d29d281f..cfb943f9 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/create.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/create.md @@ -3,7 +3,7 @@ # create [common]\ -fun <[D](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [create](create.md)(maxEntries: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [MemorySyncDelegate](../index.md)<[D](create.md), [P](create.md)> +fun <[D](create.md) : Any, [P](create.md) : Any> [create](create.md)(maxEntries: Long): [MemorySyncDelegate](../index.md)<[D](create.md), [P](create.md)> Creates an in-memory LRU cache with [maxEntries](create.md) records maximum to accommodate this many elements. diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/index.md index 57929630..893a72b9 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-companion/index.md @@ -9,4 +9,4 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [create](create.md) | [common]
fun <[D](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [create](create.md)(maxEntries: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)): [MemorySyncDelegate](../index.md)<[D](create.md), [P](create.md)>
Creates an in-memory LRU cache with [maxEntries](create.md) records maximum to accommodate this many elements. | +| [create](create.md) | [common]
fun <[D](create.md) : Any, [P](create.md) : Any> [create](create.md)(maxEntries: Long): [MemorySyncDelegate](../index.md)<[D](create.md), [P](create.md)>
Creates an in-memory LRU cache with [maxEntries](create.md) records maximum to accommodate this many elements. | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/index.md index 606192c6..08d11646 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/index.md @@ -3,7 +3,7 @@ # MemorySyncDelegate [common]\ -abstract class [MemorySyncDelegate](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [CacheDelegate](../-cache-delegate/index.md)<[D](index.md), [P](index.md)> +abstract class [MemorySyncDelegate](index.md)<[D](index.md) : Any, [P](index.md) : Any> : [CacheDelegate](../-cache-delegate/index.md)<[D](index.md), [P](index.md)> A simple memory cache for cache-service @@ -42,5 +42,5 @@ common | Name | Summary | |---|---| -| [makeFriendParams](../make-friend-params.md) | [common]
inline fun <[D](../make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [CacheFriend](../-cache-friend/index.md)>.[makeFriendParams](../make-friend-params.md)(crossinline stringify: [P](../make-friend-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [P](../make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](../-cache-friend/index.md) params using [stringify](../make-friend-params.md) function | -| [stringifyParams](../stringify-params.md) | [common]
inline fun <[D](../stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>.[stringifyParams](../stringify-params.md)(crossinline stringify: [P](../stringify-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = { toString() }): [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), [P](../stringify-params.md)>
Creates an adapter delegate that [stringify](../stringify-params.md) and uses result string as params to receiver | +| [makeFriendParams](../make-friend-params.md) | [common]
inline fun <[D](../make-friend-params.md) : Any, [P](../make-friend-params.md) : Any> [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [CacheFriend](../-cache-friend/index.md)>.[makeFriendParams](../make-friend-params.md)(crossinline stringify: [P](../make-friend-params.md).() -> String): [CacheDelegate](../-cache-delegate/index.md)<[D](../make-friend-params.md), [P](../make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](../-cache-friend/index.md) params using [stringify](../make-friend-params.md) function | +| [stringifyParams](../stringify-params.md) | [common]
inline fun <[D](../stringify-params.md) : Any, [P](../stringify-params.md) : Any> [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), String>.[stringifyParams](../stringify-params.md)(crossinline stringify: [P](../stringify-params.md).() -> String = { toString() }): [CacheDelegate](../-cache-delegate/index.md)<[D](../stringify-params.md), [P](../stringify-params.md)>
Creates an adapter delegate that [stringify](../stringify-params.md) and uses result string as params to receiver | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/deserialize-snapshot.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/deserialize-snapshot.md index e28df245..32505a5c 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/deserialize-snapshot.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/deserialize-snapshot.md @@ -3,7 +3,7 @@ # deserializeSnapshot [jvm]\ -open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>>? +open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>>? Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/index.md index 80903016..218f5c56 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/index.md @@ -26,5 +26,5 @@ jvm | Name | Summary | |---|---| -| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>>?
Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream | +| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>>?
Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream | | [serialize](serialize.md) | [jvm]
open override fun [serialize](serialize.md)(entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>>, output: [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html))
Serializes [entity](serialize.md) to [output](serialize.md) stream | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/index.md index fea1538d..3cc003e0 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/index.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/index.md @@ -6,18 +6,18 @@ | Name | Summary | |---|---| -| [CacheDelegate](-cache-delegate/index.md) | [common]
interface [CacheDelegate](-cache-delegate/index.md)<[D](-cache-delegate/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](-cache-delegate/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Delegate that synchronously performs caching operations | -| [CacheDelegateSerializerDeserializer](-cache-delegate-serializer-deserializer/index.md) | [jvm]
interface [CacheDelegateSerializerDeserializer](-cache-delegate-serializer-deserializer/index.md)<[D](-cache-delegate-serializer-deserializer/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Serializer for cache delegates | +| [CacheDelegate](-cache-delegate/index.md) | [common]
interface [CacheDelegate](-cache-delegate/index.md)<[D](-cache-delegate/index.md) : Any, [P](-cache-delegate/index.md) : Any>
Delegate that synchronously performs caching operations | +| [CacheDelegateSerializerDeserializer](-cache-delegate-serializer-deserializer/index.md) | [jvm]
interface [CacheDelegateSerializerDeserializer](-cache-delegate-serializer-deserializer/index.md)<[D](-cache-delegate-serializer-deserializer/index.md) : Any>
Serializer for cache delegates | | [CacheFriend](-cache-friend/index.md) | [common]
interface [CacheFriend](-cache-friend/index.md)
Generates a cache-friendly key value for parameters | -| [CacheFriendDelegate](-cache-friend-delegate/index.md) | [common]
class [CacheFriendDelegate](-cache-friend-delegate/index.md)<[D](-cache-friend-delegate/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](-cache-friend-delegate/index.md) : [CacheFriend](-cache-friend/index.md)>(delegate: [CacheDelegate](-cache-delegate/index.md)<[DataWithCacheKey](-data-with-cache-key/index.md)<[D](-cache-friend-delegate/index.md)>, [P](-cache-friend-delegate/index.md)>) : [CacheDelegate](-cache-delegate/index.md)<[D](-cache-friend-delegate/index.md), [P](-cache-friend-delegate/index.md)>
Wraps [delegate](../../../cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/delegate.md) adding unmodified [CacheFriend.cacheKey](-cache-friend/cache-key.md) to the mix with data. Validates that key on [get](-cache-friend-delegate/get.md) and returns null if it is not equals original. Helps to make sure the data returned is not a result of clashed cache key. | +| [CacheFriendDelegate](-cache-friend-delegate/index.md) | [common]
class [CacheFriendDelegate](-cache-friend-delegate/index.md)<[D](-cache-friend-delegate/index.md) : Any, [P](-cache-friend-delegate/index.md) : [CacheFriend](-cache-friend/index.md)>(delegate: [CacheDelegate](-cache-delegate/index.md)<[DataWithCacheKey](-data-with-cache-key/index.md)<[D](-cache-friend-delegate/index.md)>, [P](-cache-friend-delegate/index.md)>) : [CacheDelegate](-cache-delegate/index.md)<[D](-cache-friend-delegate/index.md), [P](-cache-friend-delegate/index.md)>
Wraps [delegate](../../../cache/com.motorro.rxlcemodel.cache/-cache-friend-delegate/delegate.md) adding unmodified [CacheFriend.cacheKey](-cache-friend/cache-key.md) to the mix with data. Validates that key on [get](-cache-friend-delegate/get.md) and returns null if it is not equals original. Helps to make sure the data returned is not a result of clashed cache key. | | [CacheManager](-cache-manager/index.md) | [common]
interface [CacheManager](-cache-manager/index.md)
Closes and deletes cache May be used to close or delete all scoped cache at once e.g. for current user | -| [DataWithCacheKey](-data-with-cache-key/index.md) | [common]
data class [DataWithCacheKey](-data-with-cache-key/index.md)<[D](-data-with-cache-key/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [D](-data-with-cache-key/index.md), val cacheKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Data combined with full cached key to validate we get exactly what we are looking for For example, DiskLruCache has strict requirements and limited length of a cache key and hashing of keys may be required to fit into requirements - thus there is a possibility of key clash. | -| [MemorySyncDelegate](-memory-sync-delegate/index.md) | [common]
abstract class [MemorySyncDelegate](-memory-sync-delegate/index.md)<[D](-memory-sync-delegate/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](-memory-sync-delegate/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [CacheDelegate](-cache-delegate/index.md)<[D](-memory-sync-delegate/index.md), [P](-memory-sync-delegate/index.md)>
A simple memory cache for cache-service | +| [DataWithCacheKey](-data-with-cache-key/index.md) | [common]
data class [DataWithCacheKey](-data-with-cache-key/index.md)<[D](-data-with-cache-key/index.md) : Any>(val data: [D](-data-with-cache-key/index.md), val cacheKey: String)
Data combined with full cached key to validate we get exactly what we are looking for For example, DiskLruCache has strict requirements and limited length of a cache key and hashing of keys may be required to fit into requirements - thus there is a possibility of key clash. | +| [MemorySyncDelegate](-memory-sync-delegate/index.md) | [common]
abstract class [MemorySyncDelegate](-memory-sync-delegate/index.md)<[D](-memory-sync-delegate/index.md) : Any, [P](-memory-sync-delegate/index.md) : Any> : [CacheDelegate](-cache-delegate/index.md)<[D](-memory-sync-delegate/index.md), [P](-memory-sync-delegate/index.md)>
A simple memory cache for cache-service | | [WithObjectStreamAndCacheKey](-with-object-stream-and-cache-key/index.md) | [jvm]
class [WithObjectStreamAndCacheKey](-with-object-stream-and-cache-key/index.md)<[D](-with-object-stream-and-cache-key/index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)>(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), dataClass: [Class](https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html)<[D](-with-object-stream-and-cache-key/index.md)>) : [CacheDelegateSerializerDeserializer](-cache-delegate-serializer-deserializer/index.md)<[DataWithCacheKey](../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](-with-object-stream-and-cache-key/index.md)>>
Serializes and deserializes [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) objects along with their caching key | ## Functions | Name | Summary | |---|---| -| [makeFriendParams](make-friend-params.md) | [common]
inline fun <[D](make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [CacheFriend](-cache-friend/index.md)>.[makeFriendParams](make-friend-params.md)(crossinline stringify: [P](make-friend-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [P](make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](-cache-friend/index.md) params using [stringify](make-friend-params.md) function | -| [stringifyParams](stringify-params.md) | [common]
inline fun <[D](stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>.[stringifyParams](stringify-params.md)(crossinline stringify: [P](stringify-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = { toString() }): [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), [P](stringify-params.md)>
Creates an adapter delegate that [stringify](stringify-params.md) and uses result string as params to receiver | +| [makeFriendParams](make-friend-params.md) | [common]
inline fun <[D](make-friend-params.md) : Any, [P](make-friend-params.md) : Any> [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [CacheFriend](-cache-friend/index.md)>.[makeFriendParams](make-friend-params.md)(crossinline stringify: [P](make-friend-params.md).() -> String): [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [P](make-friend-params.md)>
Creates an adapter delegate that creates [CacheFriend](-cache-friend/index.md) params using [stringify](make-friend-params.md) function | +| [stringifyParams](stringify-params.md) | [common]
inline fun <[D](stringify-params.md) : Any, [P](stringify-params.md) : Any> [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), String>.[stringifyParams](stringify-params.md)(crossinline stringify: [P](stringify-params.md).() -> String = { toString() }): [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), [P](stringify-params.md)>
Creates an adapter delegate that [stringify](stringify-params.md) and uses result string as params to receiver | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/make-friend-params.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/make-friend-params.md index cb56caf2..38498b5f 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/make-friend-params.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/make-friend-params.md @@ -3,7 +3,7 @@ # makeFriendParams [common]\ -inline fun <[D](make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](make-friend-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [CacheFriend](-cache-friend/index.md)>.[makeFriendParams](make-friend-params.md)(crossinline stringify: [P](make-friend-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [P](make-friend-params.md)> +inline fun <[D](make-friend-params.md) : Any, [P](make-friend-params.md) : Any> [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [CacheFriend](-cache-friend/index.md)>.[makeFriendParams](make-friend-params.md)(crossinline stringify: [P](make-friend-params.md).() -> String): [CacheDelegate](-cache-delegate/index.md)<[D](make-friend-params.md), [P](make-friend-params.md)> Creates an adapter delegate that creates [CacheFriend](-cache-friend/index.md) params using [stringify](make-friend-params.md) function diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/stringify-params.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/stringify-params.md index 2c72f8f9..61128744 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/stringify-params.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/stringify-params.md @@ -3,7 +3,7 @@ # stringifyParams [common]\ -inline fun <[D](stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](stringify-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>.[stringifyParams](stringify-params.md)(crossinline stringify: [P](stringify-params.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = { toString() }): [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), [P](stringify-params.md)> +inline fun <[D](stringify-params.md) : Any, [P](stringify-params.md) : Any> [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), String>.[stringifyParams](stringify-params.md)(crossinline stringify: [P](stringify-params.md).() -> String = { toString() }): [CacheDelegate](-cache-delegate/index.md)<[D](stringify-params.md), [P](stringify-params.md)> Creates an adapter delegate that [stringify](stringify-params.md) and uses result string as params to receiver diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/-data-with-cache-key-serializer.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/-data-with-cache-key-serializer.md index 0e1e9246..1a6b41e4 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/-data-with-cache-key-serializer.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/-data-with-cache-key-serializer.md @@ -3,4 +3,4 @@ # DataWithCacheKeySerializer [jvm]\ -fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md)(dataSerializer: KSerializer<[D](index.md)>) +fun <[D](index.md) : Any> [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md)(dataSerializer: KSerializer<[D](index.md)>) diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/index.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/index.md index dff05304..389f3f67 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/index.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-data-with-cache-key-serializer/index.md @@ -5,7 +5,7 @@ [jvm]\ @ExperimentalSerializationApi -data class [DataWithCacheKeySerializer](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val dataSerializer: KSerializer<[D](index.md)>) : KSerializer<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>> +data class [DataWithCacheKeySerializer](index.md)<[D](index.md) : Any>(val dataSerializer: KSerializer<[D](index.md)>) : KSerializer<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>> Serializer for [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md) @@ -13,7 +13,7 @@ Serializer for [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel | | | |---|---| -| [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md) | [jvm]
fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md)(dataSerializer: KSerializer<[D](index.md)>) | +| [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md) | [jvm]
fun <[D](index.md) : Any> [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md)(dataSerializer: KSerializer<[D](index.md)>) | ## Functions diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/-kotlin-cache-delegate-serializer.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/-kotlin-cache-delegate-serializer.md index 9ce27c26..9998135a 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/-kotlin-cache-delegate-serializer.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/-kotlin-cache-delegate-serializer.md @@ -3,7 +3,7 @@ # KotlinCacheDelegateSerializer [jvm]\ -fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md)(validatorFactory: [EntityValidatorFactory](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](index.md)>, binaryFormat: BinaryFormat) +fun <[D](index.md) : Any> [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md)(validatorFactory: [EntityValidatorFactory](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](index.md)>, binaryFormat: BinaryFormat) #### Parameters diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/deserialize-snapshot.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/deserialize-snapshot.md index 3ba940d6..03d15525 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/deserialize-snapshot.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/deserialize-snapshot.md @@ -3,7 +3,7 @@ # deserializeSnapshot [jvm]\ -open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>? +open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>? Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) snapshot from [input](deserialize-snapshot.md) stream Snapshots are used because the validity status is only actual when we are getting cached data. https://github.com/motorro/RxLceModel/issues/5 diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/index.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/index.md index 50dfc1cb..13ff061b 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/index.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/-kotlin-cache-delegate-serializer/index.md @@ -5,7 +5,7 @@ [jvm]\ @ExperimentalSerializationApi -class [KotlinCacheDelegateSerializer](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(validatorFactory: [EntityValidatorFactory](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](index.md)>, binaryFormat: BinaryFormat) : [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)> +class [KotlinCacheDelegateSerializer](index.md)<[D](index.md) : Any>(validatorFactory: [EntityValidatorFactory](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](index.md)>, binaryFormat: BinaryFormat) : [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)> Serializes and deserializes objects with kotlinx.serialization.KSerializer @@ -23,11 +23,11 @@ jvm | | | |---|---| -| [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md) | [jvm]
fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md)(validatorFactory: [EntityValidatorFactory](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](index.md)>, binaryFormat: BinaryFormat) | +| [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md) | [jvm]
fun <[D](index.md) : Any> [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md)(validatorFactory: [EntityValidatorFactory](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](index.md)>, binaryFormat: BinaryFormat) | ## Functions | Name | Summary | |---|---| -| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), invalidated: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) snapshot from [input](deserialize-snapshot.md) stream Snapshots are used because the validity status is only actual when we are getting cached data. https://github.com/motorro/RxLceModel/issues/5 | +| [deserializeSnapshot](deserialize-snapshot.md) | [jvm]
open override fun [deserializeSnapshot](deserialize-snapshot.md)(input: [InputStream](https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html), length: Long, invalidated: Boolean): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) snapshot from [input](deserialize-snapshot.md) stream Snapshots are used because the validity status is only actual when we are getting cached data. https://github.com/motorro/RxLceModel/issues/5 | | [serialize](serialize.md) | [jvm]
open override fun [serialize](serialize.md)(entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>, output: [OutputStream](https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html))
Serializes [entity](serialize.md) to [output](serialize.md) stream | diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/index.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/index.md index 435db617..a1a8d88d 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/index.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/index.md @@ -6,12 +6,12 @@ | Name | Summary | |---|---| -| [DataWithCacheKeySerializer](-data-with-cache-key-serializer/index.md) | [jvm]
@ExperimentalSerializationApi
data class [DataWithCacheKeySerializer](-data-with-cache-key-serializer/index.md)<[D](-data-with-cache-key-serializer/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val dataSerializer: KSerializer<[D](-data-with-cache-key-serializer/index.md)>) : KSerializer<[DataWithCacheKey](../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](-data-with-cache-key-serializer/index.md)>>
Serializer for [DataWithCacheKey](../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md) | -| [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer/index.md) | [jvm]
@ExperimentalSerializationApi
class [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer/index.md)<[D](-kotlin-cache-delegate-serializer/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](-kotlin-cache-delegate-serializer/index.md)>, binaryFormat: BinaryFormat) : [CacheDelegateSerializerDeserializer](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](-kotlin-cache-delegate-serializer/index.md)>
Serializes and deserializes objects with kotlinx.serialization.KSerializer | +| [DataWithCacheKeySerializer](-data-with-cache-key-serializer/index.md) | [jvm]
@ExperimentalSerializationApi
data class [DataWithCacheKeySerializer](-data-with-cache-key-serializer/index.md)<[D](-data-with-cache-key-serializer/index.md) : Any>(val dataSerializer: KSerializer<[D](-data-with-cache-key-serializer/index.md)>) : KSerializer<[DataWithCacheKey](../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](-data-with-cache-key-serializer/index.md)>>
Serializer for [DataWithCacheKey](../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md) | +| [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer/index.md) | [jvm]
@ExperimentalSerializationApi
class [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer/index.md)<[D](-kotlin-cache-delegate-serializer/index.md) : Any>(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), kSerializer: KSerializer<[D](-kotlin-cache-delegate-serializer/index.md)>, binaryFormat: BinaryFormat) : [CacheDelegateSerializerDeserializer](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](-kotlin-cache-delegate-serializer/index.md)>
Serializes and deserializes objects with kotlinx.serialization.KSerializer | ## Functions | Name | Summary | |---|---| -| [withKotlin](with-kotlin.md) | [jvm]
@ExperimentalSerializationApi
inline fun <[D](with-kotlin.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)>
@ExperimentalSerializationApi
inline fun <[D](with-kotlin.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)>
Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data | -| [withKotlinNormalized](with-kotlin-normalized.md) | [jvm]
@ExperimentalSerializationApi
inline fun <[D](with-kotlin-normalized.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin-normalized.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)>
@ExperimentalSerializationApi
inline fun <[D](with-kotlin-normalized.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin-normalized.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin-normalized.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)>
Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data with cache key normalizing and check. | +| [withKotlin](with-kotlin.md) | [jvm]
@ExperimentalSerializationApi
inline fun <[D](with-kotlin.md) : Any, [P](with-kotlin.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)>
@ExperimentalSerializationApi
inline fun <[D](with-kotlin.md) : Any, [P](with-kotlin.md) : Any> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin.md).() -> String): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)>
Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data | +| [withKotlinNormalized](with-kotlin-normalized.md) | [jvm]
@ExperimentalSerializationApi
inline fun <[D](with-kotlin-normalized.md) : Any, [P](with-kotlin-normalized.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)>
@ExperimentalSerializationApi
inline fun <[D](with-kotlin-normalized.md) : Any, [P](with-kotlin-normalized.md) : Any> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin-normalized.md).() -> String): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)>
Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data with cache key normalizing and check. | diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin-normalized.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin-normalized.md index 8c73cfcb..075dde8a 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin-normalized.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin-normalized.md @@ -6,7 +6,7 @@ @ExperimentalSerializationApi -inline fun <[D](with-kotlin-normalized.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin-normalized.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)> +inline fun <[D](with-kotlin-normalized.md) : Any, [P](with-kotlin-normalized.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)> Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data with cache key normalizing and check. @@ -29,7 +29,7 @@ jvm @ExperimentalSerializationApi -inline fun <[D](with-kotlin-normalized.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin-normalized.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin-normalized.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)> +inline fun <[D](with-kotlin-normalized.md) : Any, [P](with-kotlin-normalized.md) : Any> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlinNormalized](with-kotlin-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin-normalized.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin-normalized.md).() -> String): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin-normalized.md), [P](with-kotlin-normalized.md)> Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data with cache key normalizing and check. diff --git a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin.md b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin.md index ef810ab7..4a656481 100644 --- a/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin.md +++ b/docs/kserializer/kserializer/com.motorro.rxlcemodel.kserializer/with-kotlin.md @@ -6,7 +6,7 @@ @ExperimentalSerializationApi -inline fun <[D](with-kotlin.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)> +inline fun <[D](with-kotlin.md) : Any, [P](with-kotlin.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)> Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data @@ -29,7 +29,7 @@ jvm @ExperimentalSerializationApi -inline fun <[D](with-kotlin.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-kotlin.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin.md).() -> [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)> +inline fun <[D](with-kotlin.md) : Any, [P](with-kotlin.md) : Any> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](../../../disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withKotlin](with-kotlin.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), serializer: KSerializer<[D](with-kotlin.md)>, binaryFormat: BinaryFormat = Cbor, prefix: String = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-kotlin.md).() -> String): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-kotlin.md), [P](with-kotlin.md)> Creates DiskLRU caching delegate for cache-service that accepts Kotlin-serializable data diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/-content.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/-content.md index fe66e529..d6652490 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/-content.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/-content.md @@ -3,4 +3,4 @@ # Content [common]\ -fun <out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Content](-content.md)(data: [DATA](index.md), dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) +fun <out [DATA](index.md) : Any> [Content](-content.md)(data: [DATA](index.md), dataIsValid: Boolean) diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/data-is-valid.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/data-is-valid.md index 36e80a61..78828031 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/data-is-valid.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/data-is-valid.md @@ -3,4 +3,4 @@ # dataIsValid [common]\ -open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override val [dataIsValid](data-is-valid.md): Boolean diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/index.md index e07f4224..b8e9f0b9 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-content/index.md @@ -3,7 +3,7 @@ # Content [common]\ -data class [Content](index.md)<out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [DATA](index.md), val dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [LceState](../index.md)<[DATA](index.md)> +data class [Content](index.md)<out [DATA](index.md) : Any>(val data: [DATA](index.md), val dataIsValid: Boolean) : [LceState](../index.md)<[DATA](index.md)> Data is loaded and content is displayed @@ -11,13 +11,13 @@ Data is loaded and content is displayed | | | |---|---| -| [Content](-content.md) | [common]
fun <out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Content](-content.md)(data: [DATA](index.md), dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | +| [Content](-content.md) | [common]
fun <out [DATA](index.md) : Any> [Content](-content.md)(data: [DATA](index.md), dataIsValid: Boolean) | ## Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [LceState.Error](../-error/index.md)<[DATA](index.md)>
Transfers to [Error](../-error/index.md) state preserving data | +| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: Throwable): [LceState.Error](../-error/index.md)<[DATA](index.md)>
Transfers to [Error](../-error/index.md) state preserving data | | [toLoading](../to-loading.md) | [common]
fun [toLoading](../to-loading.md)(type: [LceState.Loading.Type](../-loading/-type/index.md) = Loading.Type.LOADING): [LceState.Loading](../-loading/index.md)<[DATA](index.md)>
Transfers to [Loading](../-loading/index.md) state preserving data | ## Properties @@ -25,14 +25,15 @@ Data is loaded and content is displayed | Name | Summary | |---|---| | [data](data.md) | [common]
open override val [data](data.md): [DATA](index.md)
State data | -| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Data validity at the time of emission | +| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): Boolean
Data validity at the time of emission | ## Extensions | Name | Summary | |---|---| -| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](../-error/index.md): | -| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | -| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | -| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | -| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | +| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : Any, [DATA_2](../../catch-to-lce.md) : Any> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](../-error/index.md): | +| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : Any, [DATA_2](../../combine.md) : Any, [DATA_3](../../combine.md) : Any> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : Any, [DATA_2](../../flat-map.md) : Any> [LceState](../index.md)<[DATA_1](../../flat-map.md)>.[flatMap](../../flat-map.md)(mapper: (data1: [DATA_1](../../flat-map.md)) -> [LceState](../index.md)<[DATA_2](../../flat-map.md)>): [LceState](../index.md)<[DATA_2](../../flat-map.md)>
Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : Any, [DATA_2](../../map.md) : Any> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | +| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | +| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/-error.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/-error.md index d86a4ca7..de0adc87 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/-error.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/-error.md @@ -3,4 +3,4 @@ # Error [common]\ -fun <out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Error](-error.md)(data: [DATA](index.md)?, dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) +fun <out [DATA](index.md) : Any> [Error](-error.md)(data: [DATA](index.md)?, dataIsValid: Boolean, error: Throwable) diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/data-is-valid.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/data-is-valid.md index a6abfdc8..03292e34 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/data-is-valid.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/data-is-valid.md @@ -3,4 +3,4 @@ # dataIsValid [common]\ -open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override val [dataIsValid](data-is-valid.md): Boolean diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/error.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/error.md index 3d912b85..205ebfbe 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/error.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/error.md @@ -3,4 +3,4 @@ # error [common]\ -val [error](error.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) +val [error](error.md): Throwable diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md index cf5c09b7..964f162d 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md @@ -3,7 +3,7 @@ # Error [common]\ -data class [Error](index.md)<out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [DATA](index.md)?, val dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), val error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [LceState](../index.md)<[DATA](index.md)> +data class [Error](index.md)<out [DATA](index.md) : Any>(val data: [DATA](index.md)?, val dataIsValid: Boolean, val error: Throwable) : [LceState](../index.md)<[DATA](index.md)> Data (or part of it) failed to load @@ -11,13 +11,13 @@ Data (or part of it) failed to load | | | |---|---| -| [Error](-error.md) | [common]
fun <out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Error](-error.md)(data: [DATA](index.md)?, dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [Error](-error.md) | [common]
fun <out [DATA](index.md) : Any> [Error](-error.md)(data: [DATA](index.md)?, dataIsValid: Boolean, error: Throwable) | ## Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [LceState.Error](index.md)<[DATA](index.md)>
Transfers to [Error](index.md) state preserving data | +| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: Throwable): [LceState.Error](index.md)<[DATA](index.md)>
Transfers to [Error](index.md) state preserving data | | [toLoading](../to-loading.md) | [common]
fun [toLoading](../to-loading.md)(type: [LceState.Loading.Type](../-loading/-type/index.md) = Loading.Type.LOADING): [LceState.Loading](../-loading/index.md)<[DATA](index.md)>
Transfers to [Loading](../-loading/index.md) state preserving data | ## Properties @@ -25,15 +25,16 @@ Data (or part of it) failed to load | Name | Summary | |---|---| | [data](data.md) | [common]
open override val [data](data.md): [DATA](index.md)?
State data | -| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Data validity at the time of emission | -| [error](error.md) | [common]
val [error](error.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)
Data load error | +| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): Boolean
Data validity at the time of emission | +| [error](error.md) | [common]
val [error](error.md): Throwable
Data load error | ## Extensions | Name | Summary | |---|---| -| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](index.md): | -| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | -| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | -| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | -| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | +| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : Any, [DATA_2](../../catch-to-lce.md) : Any> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](index.md): | +| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : Any, [DATA_2](../../combine.md) : Any, [DATA_3](../../combine.md) : Any> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : Any, [DATA_2](../../flat-map.md) : Any> [LceState](../index.md)<[DATA_1](../../flat-map.md)>.[flatMap](../../flat-map.md)(mapper: (data1: [DATA_1](../../flat-map.md)) -> [LceState](../index.md)<[DATA_2](../../flat-map.md)>): [LceState](../index.md)<[DATA_2](../../flat-map.md)>
Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : Any, [DATA_2](../../map.md) : Any> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | +| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | +| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-loading.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-loading.md index e31599c7..f5785aae 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-loading.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-loading.md @@ -3,4 +3,4 @@ # Loading [common]\ -fun <out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Loading](-loading.md)(data: [DATA](index.md)?, dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) +fun <out [DATA](index.md) : Any> [Loading](-loading.md)(data: [DATA](index.md)?, dataIsValid: Boolean, type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g/index.md index d30a1a71..709956a5 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g/index.md @@ -11,5 +11,5 @@ Just loads. May be initial load operation | Name | Summary | |---|---| -| [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): String | +| [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): Int | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g_-m-o-r-e/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g_-m-o-r-e/index.md index 293d72b8..2329ee68 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g_-m-o-r-e/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-l-o-a-d-i-n-g_-m-o-r-e/index.md @@ -11,5 +11,5 @@ Loading more items for paginated view | Name | Summary | |---|---| -| [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): String | +| [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): Int | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-r-e-f-r-e-s-h-i-n-g/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-r-e-f-r-e-s-h-i-n-g/index.md index 48fc1d94..fd766ff5 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-r-e-f-r-e-s-h-i-n-g/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-r-e-f-r-e-s-h-i-n-g/index.md @@ -11,5 +11,5 @@ Refreshing content | Name | Summary | |---|---| -| [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](../-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): String | +| [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](../-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): Int | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-u-p-d-a-t-i-n-g/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-u-p-d-a-t-i-n-g/index.md index b0ca6d29..58429426 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-u-p-d-a-t-i-n-g/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-u-p-d-a-t-i-n-g/index.md @@ -11,5 +11,5 @@ Updating data on server | Name | Summary | |---|---| -| [name](index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](index.md#-372974862%2FProperties%2F-702262346): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F-702262346): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](index.md#-372974862%2FProperties%2F-702262346): String | +| [ordinal](index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F-702262346): Int | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/index.md index c1094fa0..83f74326 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/index.md @@ -3,7 +3,7 @@ # Type [common]\ -enum [Type](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LceState.Loading.Type](index.md)> +enum [Type](index.md) : Enum<[LceState.Loading.Type](index.md)> Loading type @@ -20,12 +20,12 @@ Loading type | Name | Summary | |---|---| -| [valueOf](value-of.md) | [common]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [LceState.Loading.Type](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | -| [values](values.md) | [common]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[LceState.Loading.Type](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | +| [valueOf](value-of.md) | [common]
fun [valueOf](value-of.md)(value: String): [LceState.Loading.Type](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | +| [values](values.md) | [common]
fun [values](values.md)(): Array<[LceState.Loading.Type](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | ## Properties | Name | Summary | |---|---| -| [name](-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [name](-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346) | [common]
val [name](-u-p-d-a-t-i-n-g/index.md#-372974862%2FProperties%2F-702262346): String | +| [ordinal](-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](-u-p-d-a-t-i-n-g/index.md#-739389684%2FProperties%2F-702262346): Int | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/value-of.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/value-of.md index 361958dd..2b8b59f2 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/value-of.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/value-of.md @@ -3,7 +3,7 @@ # valueOf [common]\ -fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [LceState.Loading.Type](index.md) +fun [valueOf](value-of.md)(value: String): [LceState.Loading.Type](index.md) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) @@ -11,4 +11,4 @@ Returns the enum constant of this type with the specified name. The string must | | | |---|---| -| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if this enum type has no constant with the specified name | +| IllegalArgumentException | if this enum type has no constant with the specified name | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/values.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/values.md index d861f67c..b471a2fd 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/values.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/values.md @@ -3,7 +3,7 @@ # values [common]\ -fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[LceState.Loading.Type](index.md)> +fun [values](values.md)(): Array<[LceState.Loading.Type](index.md)> Returns an array containing the constants of this enum type, in the order they're declared. diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/data-is-valid.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/data-is-valid.md index de187683..f5510293 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/data-is-valid.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/data-is-valid.md @@ -3,4 +3,4 @@ # dataIsValid [common]\ -open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open override val [dataIsValid](data-is-valid.md): Boolean diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md index 2a84b00c..7d463f39 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md @@ -3,7 +3,7 @@ # Loading [common]\ -data class [Loading](index.md)<out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [DATA](index.md)?, val dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), val type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) : [LceState](../index.md)<[DATA](index.md)> +data class [Loading](index.md)<out [DATA](index.md) : Any>(val data: [DATA](index.md)?, val dataIsValid: Boolean, val type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) : [LceState](../index.md)<[DATA](index.md)> View is loading @@ -11,19 +11,19 @@ View is loading | | | |---|---| -| [Loading](-loading.md) | [common]
fun <out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [Loading](-loading.md)(data: [DATA](index.md)?, dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) | +| [Loading](-loading.md) | [common]
fun <out [DATA](index.md) : Any> [Loading](-loading.md)(data: [DATA](index.md)?, dataIsValid: Boolean, type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) | ## Types | Name | Summary | |---|---| -| [Type](-type/index.md) | [common]
enum [Type](-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LceState.Loading.Type](-type/index.md)>
Loading type | +| [Type](-type/index.md) | [common]
enum [Type](-type/index.md) : Enum<[LceState.Loading.Type](-type/index.md)>
Loading type | ## Functions | Name | Summary | |---|---| -| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [LceState.Error](../-error/index.md)<[DATA](index.md)>
Transfers to [Error](../-error/index.md) state preserving data | +| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: Throwable): [LceState.Error](../-error/index.md)<[DATA](index.md)>
Transfers to [Error](../-error/index.md) state preserving data | | [toLoading](../to-loading.md) | [common]
fun [toLoading](../to-loading.md)(type: [LceState.Loading.Type](-type/index.md) = Loading.Type.LOADING): [LceState.Loading](index.md)<[DATA](index.md)>
Transfers to [Loading](index.md) state preserving data | ## Properties @@ -31,15 +31,16 @@ View is loading | Name | Summary | |---|---| | [data](data.md) | [common]
open override val [data](data.md): [DATA](index.md)?
State data | -| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Data validity at the time of emission | +| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): Boolean
Data validity at the time of emission | | [type](type.md) | [common]
val [type](type.md): [LceState.Loading.Type](-type/index.md)
Loading type | ## Extensions | Name | Summary | |---|---| -| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](../-error/index.md): | -| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | -| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | -| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | -| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | +| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : Any, [DATA_2](../../catch-to-lce.md) : Any> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](../-error/index.md): | +| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : Any, [DATA_2](../../combine.md) : Any, [DATA_3](../../combine.md) : Any> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : Any, [DATA_2](../../flat-map.md) : Any> [LceState](../index.md)<[DATA_1](../../flat-map.md)>.[flatMap](../../flat-map.md)(mapper: (data1: [DATA_1](../../flat-map.md)) -> [LceState](../index.md)<[DATA_2](../../flat-map.md)>): [LceState](../index.md)<[DATA_2](../../flat-map.md)>
Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : Any, [DATA_2](../../map.md) : Any> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | +| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | +| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data-is-valid.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data-is-valid.md index 501c29fb..418b904e 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data-is-valid.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data-is-valid.md @@ -3,6 +3,6 @@ # dataIsValid [common]\ -open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false +open override val [dataIsValid](data-is-valid.md): Boolean = false A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data.md index 02868f34..aa523a8e 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/data.md @@ -3,6 +3,6 @@ # data [common]\ -open override val [data](data.md): [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)? = null +open override val [data](data.md): Nothing? = null State data diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/equals.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/equals.md index baaf1e95..c56aca61 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/equals.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/equals.md @@ -3,4 +3,4 @@ # equals [common]\ -open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open operator override fun [equals](equals.md)(other: Any?): Boolean diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/hash-code.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/hash-code.md index e523c188..9f3c43d7 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/hash-code.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/hash-code.md @@ -3,4 +3,4 @@ # hashCode [common]\ -open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) +open override fun [hashCode](hash-code.md)(): Int diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/index.md index 2a861264..1b0d1354 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/index.md @@ -3,7 +3,7 @@ # Terminated [common]\ -object [Terminated](index.md) : [LceState](../index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)> +object [Terminated](index.md) : [LceState](../index.md)<Nothing> A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](../index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. @@ -11,24 +11,25 @@ A special state that may be used to terminate state emission in cases we always | Name | Summary | |---|---| -| [equals](equals.md) | [common]
open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | -| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [LceState.Error](../-error/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>
Transfers to [Error](../-error/index.md) state preserving data | -| [toLoading](../to-loading.md) | [common]
fun [toLoading](../to-loading.md)(type: [LceState.Loading.Type](../-loading/-type/index.md) = Loading.Type.LOADING): [LceState.Loading](../-loading/index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>
Transfers to [Loading](../-loading/index.md) state preserving data | +| [equals](equals.md) | [common]
open operator override fun [equals](equals.md)(other: Any?): Boolean | +| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): Int | +| [toError](../to-error.md) | [common]
fun [toError](../to-error.md)(error: Throwable): [LceState.Error](../-error/index.md)<Nothing>
Transfers to [Error](../-error/index.md) state preserving data | +| [toLoading](../to-loading.md) | [common]
fun [toLoading](../to-loading.md)(type: [LceState.Loading.Type](../-loading/-type/index.md) = Loading.Type.LOADING): [LceState.Loading](../-loading/index.md)<Nothing>
Transfers to [Loading](../-loading/index.md) state preserving data | ## Properties | Name | Summary | |---|---| -| [data](data.md) | [common]
open override val [data](data.md): [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)? = null
State data | -| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). | +| [data](data.md) | [common]
open override val [data](data.md): Nothing? = null
State data | +| [dataIsValid](data-is-valid.md) | [common]
open override val [dataIsValid](data-is-valid.md): Boolean = false
A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). | ## Extensions | Name | Summary | |---|---| -| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](../-error/index.md): | -| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](../../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | -| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | -| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | -| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | +| [catchToLce](../../catch-to-lce.md) | [common]
inline fun <[DATA_1](../../catch-to-lce.md) : Any, [DATA_2](../../catch-to-lce.md) : Any> [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.[catchToLce](../../catch-to-lce.md)(block: [LceState](../index.md)<[DATA_1](../../catch-to-lce.md)>.() -> [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>): [LceState](../index.md)<[DATA_2](../../catch-to-lce.md)>
Runs transformation [block](../../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](../-error/index.md): | +| [combine](../../combine.md) | [common]
inline fun <[DATA_1](../../combine.md) : Any, [DATA_2](../../combine.md) : Any, [DATA_3](../../combine.md) : Any> [LceState](../index.md)<[DATA_1](../../combine.md)>.[combine](../../combine.md)(other: [LceState](../index.md)<[DATA_2](../../combine.md)>, mapper: (data1: [DATA_1](../../combine.md)?, data2: [DATA_2](../../combine.md)?) -> [DATA_3](../../combine.md)?): [LceState](../index.md)<[DATA_3](../../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : Any, [DATA_2](../../flat-map.md) : Any> [LceState](../index.md)<[DATA_1](../../flat-map.md)>.[flatMap](../../flat-map.md)(mapper: (data1: [DATA_1](../../flat-map.md)) -> [LceState](../index.md)<[DATA_2](../../flat-map.md)>): [LceState](../index.md)<[DATA_2](../../flat-map.md)>
Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [map](../../map.md) | [common]
inline fun <[DATA_1](../../map.md) : Any, [DATA_2](../../map.md) : Any> [LceState](../index.md)<[DATA_1](../../map.md)>.[map](../../map.md)(mapper: (data: [DATA_1](../../map.md)) -> [DATA_2](../../map.md)): [LceState](../index.md)<[DATA_2](../../map.md)>
Maps data in LceState | +| [mapEmptyData](../../map-empty-data.md) | [common]
inline fun <[DATA](../../map-empty-data.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data.md)>.[mapEmptyData](../../map-empty-data.md)(crossinline block: ([LceState](../index.md)<[DATA](../../map-empty-data.md)>) -> [LceState](../index.md)<[DATA](../../map-empty-data.md)>): [LceState](../index.md)<[DATA](../../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../../map-empty-data.md) | +| [mapEmptyDataItem](../../map-empty-data-item.md) | [common]
inline fun <[DATA](../../map-empty-data-item.md) : Any> [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>.[mapEmptyDataItem](../../map-empty-data-item.md)(crossinline block: () -> [DATA](../../map-empty-data-item.md)?): [LceState](../index.md)<[DATA](../../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../../map-empty-data-item.md) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/data-is-valid.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/data-is-valid.md index bb26ef0d..d2d8c203 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/data-is-valid.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/data-is-valid.md @@ -3,6 +3,6 @@ # dataIsValid [common]\ -abstract val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +abstract val [dataIsValid](data-is-valid.md): Boolean A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md index e1b2b797..7fbb75fd 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md @@ -3,7 +3,7 @@ # LceState [common]\ -sealed class [LceState](index.md)<out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> +sealed class [LceState](index.md)<out [DATA](index.md) : Any> State for "Loading-Content-Error" resource which retrieves [data](data.md) @@ -19,16 +19,16 @@ common | Name | Summary | |---|---| -| [Content](-content/index.md) | [common]
data class [Content](-content/index.md)<out [DATA](-content/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [DATA](-content/index.md), val dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) : [LceState](index.md)<[DATA](-content/index.md)>
Data is loaded and content is displayed | -| [Error](-error/index.md) | [common]
data class [Error](-error/index.md)<out [DATA](-error/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [DATA](-error/index.md)?, val dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), val error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [LceState](index.md)<[DATA](-error/index.md)>
Data (or part of it) failed to load | -| [Loading](-loading/index.md) | [common]
data class [Loading](-loading/index.md)<out [DATA](-loading/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val data: [DATA](-loading/index.md)?, val dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), val type: [LceState.Loading.Type](-loading/-type/index.md) = Type.LOADING) : [LceState](index.md)<[DATA](-loading/index.md)>
View is loading | -| [Terminated](-terminated/index.md) | [common]
object [Terminated](-terminated/index.md) : [LceState](index.md)<[Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](-terminated/index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | +| [Content](-content/index.md) | [common]
data class [Content](-content/index.md)<out [DATA](-content/index.md) : Any>(val data: [DATA](-content/index.md), val dataIsValid: Boolean) : [LceState](index.md)<[DATA](-content/index.md)>
Data is loaded and content is displayed | +| [Error](-error/index.md) | [common]
data class [Error](-error/index.md)<out [DATA](-error/index.md) : Any>(val data: [DATA](-error/index.md)?, val dataIsValid: Boolean, val error: Throwable) : [LceState](index.md)<[DATA](-error/index.md)>
Data (or part of it) failed to load | +| [Loading](-loading/index.md) | [common]
data class [Loading](-loading/index.md)<out [DATA](-loading/index.md) : Any>(val data: [DATA](-loading/index.md)?, val dataIsValid: Boolean, val type: [LceState.Loading.Type](-loading/-type/index.md) = Type.LOADING) : [LceState](index.md)<[DATA](-loading/index.md)>
View is loading | +| [Terminated](-terminated/index.md) | [common]
object [Terminated](-terminated/index.md) : [LceState](index.md)<Nothing>
A special state that may be used to terminate state emission in cases we always need a latest state to proceed For example we have a view that subscribes to [LceState](index.md) for a resource identified with some PARAMS. Than a delete operation is performed on that resource and it is not available anymore. The one may emit [Terminated](-terminated/index.md) to do a special processing (e.g. close the corresponding view) instead of doing it through server request that will return a `Not found` error and doing a special case processing afterwards. Also useful when `onComplete` from state-emitter can't be processed by the end-subscriber. For example LiveData does not emit completion and caches the latest emission. So converting stream to LiveData will loose Rx completion logic. | ## Functions | Name | Summary | |---|---| -| [toError](to-error.md) | [common]
fun [toError](to-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [LceState.Error](-error/index.md)<[DATA](index.md)>
Transfers to [Error](-error/index.md) state preserving data | +| [toError](to-error.md) | [common]
fun [toError](to-error.md)(error: Throwable): [LceState.Error](-error/index.md)<[DATA](index.md)>
Transfers to [Error](-error/index.md) state preserving data | | [toLoading](to-loading.md) | [common]
fun [toLoading](to-loading.md)(type: [LceState.Loading.Type](-loading/-type/index.md) = Loading.Type.LOADING): [LceState.Loading](-loading/index.md)<[DATA](index.md)>
Transfers to [Loading](-loading/index.md) state preserving data | ## Properties @@ -36,7 +36,7 @@ common | Name | Summary | |---|---| | [data](data.md) | [common]
abstract val [data](data.md): [DATA](index.md)?
State data | -| [dataIsValid](data-is-valid.md) | [common]
abstract val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). | +| [dataIsValid](data-is-valid.md) | [common]
abstract val [dataIsValid](data-is-valid.md): Boolean
A property that is evaluated internally and may mean that data being emitted is stall, invalidated or otherwise 'not-so-valid' until some further emission (say after network reload). | ## Inheritors @@ -51,8 +51,9 @@ common | Name | Summary | |---|---| -| [catchToLce](../catch-to-lce.md) | [common]
inline fun <[DATA_1](../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](index.md)<[DATA_1](../catch-to-lce.md)>.[catchToLce](../catch-to-lce.md)(block: [LceState](index.md)<[DATA_1](../catch-to-lce.md)>.() -> [LceState](index.md)<[DATA_2](../catch-to-lce.md)>): [LceState](index.md)<[DATA_2](../catch-to-lce.md)>
Runs transformation [block](../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](-error/index.md): | -| [combine](../combine.md) | [common]
inline fun <[DATA_1](../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](../combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](index.md)<[DATA_1](../combine.md)>.[combine](../combine.md)(other: [LceState](index.md)<[DATA_2](../combine.md)>, mapper: (data1: [DATA_1](../combine.md)?, data2: [DATA_2](../combine.md)?) -> [DATA_3](../combine.md)?): [LceState](index.md)<[DATA_3](../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | -| [map](../map.md) | [common]
inline fun <[DATA_1](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceState](index.md)<[DATA_2](../map.md)>
Maps data in LceState | -| [mapEmptyData](../map-empty-data.md) | [common]
inline fun <[DATA](../map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](index.md)<[DATA](../map-empty-data.md)>.[mapEmptyData](../map-empty-data.md)(crossinline block: ([LceState](index.md)<[DATA](../map-empty-data.md)>) -> [LceState](index.md)<[DATA](../map-empty-data.md)>): [LceState](index.md)<[DATA](../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../map-empty-data.md) | -| [mapEmptyDataItem](../map-empty-data-item.md) | [common]
inline fun <[DATA](../map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](index.md)<[DATA](../map-empty-data-item.md)>.[mapEmptyDataItem](../map-empty-data-item.md)(crossinline block: () -> [DATA](../map-empty-data-item.md)?): [LceState](index.md)<[DATA](../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../map-empty-data-item.md) | +| [catchToLce](../catch-to-lce.md) | [common]
inline fun <[DATA_1](../catch-to-lce.md) : Any, [DATA_2](../catch-to-lce.md) : Any> [LceState](index.md)<[DATA_1](../catch-to-lce.md)>.[catchToLce](../catch-to-lce.md)(block: [LceState](index.md)<[DATA_1](../catch-to-lce.md)>.() -> [LceState](index.md)<[DATA_2](../catch-to-lce.md)>): [LceState](index.md)<[DATA_2](../catch-to-lce.md)>
Runs transformation [block](../catch-to-lce.md) catching any error and wrapping it to [LceState.Error](-error/index.md): | +| [combine](../combine.md) | [common]
inline fun <[DATA_1](../combine.md) : Any, [DATA_2](../combine.md) : Any, [DATA_3](../combine.md) : Any> [LceState](index.md)<[DATA_1](../combine.md)>.[combine](../combine.md)(other: [LceState](index.md)<[DATA_2](../combine.md)>, mapper: (data1: [DATA_1](../combine.md)?, data2: [DATA_2](../combine.md)?) -> [DATA_3](../combine.md)?): [LceState](index.md)<[DATA_3](../combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [flatMap](../flat-map.md) | [common]
inline fun <[DATA_1](../flat-map.md) : Any, [DATA_2](../flat-map.md) : Any> [LceState](index.md)<[DATA_1](../flat-map.md)>.[flatMap](../flat-map.md)(mapper: (data1: [DATA_1](../flat-map.md)) -> [LceState](index.md)<[DATA_2](../flat-map.md)>): [LceState](index.md)<[DATA_2](../flat-map.md)>
Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [map](../map.md) | [common]
inline fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceState](index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceState](index.md)<[DATA_2](../map.md)>
Maps data in LceState | +| [mapEmptyData](../map-empty-data.md) | [common]
inline fun <[DATA](../map-empty-data.md) : Any> [LceState](index.md)<[DATA](../map-empty-data.md)>.[mapEmptyData](../map-empty-data.md)(crossinline block: ([LceState](index.md)<[DATA](../map-empty-data.md)>) -> [LceState](index.md)<[DATA](../map-empty-data.md)>): [LceState](index.md)<[DATA](../map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](../map-empty-data.md) | +| [mapEmptyDataItem](../map-empty-data-item.md) | [common]
inline fun <[DATA](../map-empty-data-item.md) : Any> [LceState](index.md)<[DATA](../map-empty-data-item.md)>.[mapEmptyDataItem](../map-empty-data-item.md)(crossinline block: () -> [DATA](../map-empty-data-item.md)?): [LceState](index.md)<[DATA](../map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](../map-empty-data-item.md) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/to-error.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/to-error.md index 01d4e2b0..04214480 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/to-error.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/to-error.md @@ -3,7 +3,7 @@ # toError [common]\ -fun [toError](to-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [LceState.Error](-error/index.md)<[DATA](index.md)> +fun [toError](to-error.md)(error: Throwable): [LceState.Error](-error/index.md)<[DATA](index.md)> Transfers to [Error](-error/index.md) state preserving data diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/catch-to-lce.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/catch-to-lce.md index b8b62d80..20bf7f22 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/catch-to-lce.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/catch-to-lce.md @@ -3,7 +3,7 @@ # catchToLce [common]\ -inline fun <[DATA_1](catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.[catchToLce](catch-to-lce.md)(block: [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.() -> [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)>): [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)> +inline fun <[DATA_1](catch-to-lce.md) : Any, [DATA_2](catch-to-lce.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.[catchToLce](catch-to-lce.md)(block: [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.() -> [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)>): [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)> Runs transformation [block](catch-to-lce.md) catching any error and wrapping it to [LceState.Error](-lce-state/-error/index.md): diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/combine.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/combine.md index 24c9adeb..0e88e201 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/combine.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/combine.md @@ -3,7 +3,7 @@ # combine [common]\ -inline fun <[DATA_1](combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA_1](combine.md)>.[combine](combine.md)(other: [LceState](-lce-state/index.md)<[DATA_2](combine.md)>, mapper: (data1: [DATA_1](combine.md)?, data2: [DATA_2](combine.md)?) -> [DATA_3](combine.md)?): [LceState](-lce-state/index.md)<[DATA_3](combine.md)> +inline fun <[DATA_1](combine.md) : Any, [DATA_2](combine.md) : Any, [DATA_3](combine.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](combine.md)>.[combine](combine.md)(other: [LceState](-lce-state/index.md)<[DATA_2](combine.md)>, mapper: (data1: [DATA_1](combine.md)?, data2: [DATA_2](combine.md)?) -> [DATA_3](combine.md)?): [LceState](-lce-state/index.md)<[DATA_3](combine.md)> Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md new file mode 100644 index 00000000..76ced01e --- /dev/null +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md @@ -0,0 +1,20 @@ +//[lce](../../index.md)/[com.motorro.rxlcemodel.lce](index.md)/[flatMap](flat-map.md) + +# flatMap + +[common]\ +inline fun <[DATA_1](flat-map.md) : Any, [DATA_2](flat-map.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](flat-map.md)>.[flatMap](flat-map.md)(mapper: (data1: [DATA_1](flat-map.md)) -> [LceState](-lce-state/index.md)<[DATA_2](flat-map.md)>): [LceState](-lce-state/index.md)<[DATA_2](flat-map.md)> + +Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | + +#### Receiver + +An Lce state that has a priority in final state resolution + +#### Parameters + +common + +| | | +|---|---| +| mapper | Returns a new [LceState](-lce-state/index.md) as a product of receiver data | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md index 9aadad75..ca971ab6 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md @@ -6,14 +6,15 @@ | Name | Summary | |---|---| -| [LceState](-lce-state/index.md) | [common]
sealed class [LceState](-lce-state/index.md)<out [DATA](-lce-state/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
State for "Loading-Content-Error" resource which retrieves [data](-lce-state/data.md) | +| [LceState](-lce-state/index.md) | [common]
sealed class [LceState](-lce-state/index.md)<out [DATA](-lce-state/index.md) : Any>
State for "Loading-Content-Error" resource which retrieves [data](-lce-state/data.md) | ## Functions | Name | Summary | |---|---| -| [catchToLce](catch-to-lce.md) | [common]
inline fun <[DATA_1](catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](catch-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.[catchToLce](catch-to-lce.md)(block: [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.() -> [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)>): [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)>
Runs transformation [block](catch-to-lce.md) catching any error and wrapping it to [LceState.Error](-lce-state/-error/index.md): | -| [combine](combine.md) | [common]
inline fun <[DATA_1](combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_3](combine.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA_1](combine.md)>.[combine](combine.md)(other: [LceState](-lce-state/index.md)<[DATA_2](combine.md)>, mapper: (data1: [DATA_1](combine.md)?, data2: [DATA_2](combine.md)?) -> [DATA_3](combine.md)?): [LceState](-lce-state/index.md)<[DATA_3](combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | -| [map](map.md) | [common]
inline fun <[DATA_1](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceState](-lce-state/index.md)<[DATA_2](map.md)>
Maps data in LceState | -| [mapEmptyData](map-empty-data.md) | [common]
inline fun <[DATA](map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>.[mapEmptyData](map-empty-data.md)(crossinline block: ([LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>) -> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>): [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](map-empty-data.md) | -| [mapEmptyDataItem](map-empty-data-item.md) | [common]
inline fun <[DATA](map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)>.[mapEmptyDataItem](map-empty-data-item.md)(crossinline block: () -> [DATA](map-empty-data-item.md)?): [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](map-empty-data-item.md) | +| [catchToLce](catch-to-lce.md) | [common]
inline fun <[DATA_1](catch-to-lce.md) : Any, [DATA_2](catch-to-lce.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.[catchToLce](catch-to-lce.md)(block: [LceState](-lce-state/index.md)<[DATA_1](catch-to-lce.md)>.() -> [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)>): [LceState](-lce-state/index.md)<[DATA_2](catch-to-lce.md)>
Runs transformation [block](catch-to-lce.md) catching any error and wrapping it to [LceState.Error](-lce-state/-error/index.md): | +| [combine](combine.md) | [common]
inline fun <[DATA_1](combine.md) : Any, [DATA_2](combine.md) : Any, [DATA_3](combine.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](combine.md)>.[combine](combine.md)(other: [LceState](-lce-state/index.md)<[DATA_2](combine.md)>, mapper: (data1: [DATA_1](combine.md)?, data2: [DATA_2](combine.md)?) -> [DATA_3](combine.md)?): [LceState](-lce-state/index.md)<[DATA_3](combine.md)>
Combines two Lce states. Here is the result state matrix | Receiver | other | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [flatMap](flat-map.md) | [common]
inline fun <[DATA_1](flat-map.md) : Any, [DATA_2](flat-map.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](flat-map.md)>.[flatMap](flat-map.md)(mapper: (data1: [DATA_1](flat-map.md)) -> [LceState](-lce-state/index.md)<[DATA_2](flat-map.md)>): [LceState](-lce-state/index.md)<[DATA_2](flat-map.md)>
Flat-maps Lce states with the result of other Here is the result state matrix | Receiver | mapper | Result | |------------|------------|------------| | Loading | Loading | Loading | | Loading | Content | Loading | | Loading | Error | Error | | Loading | Terminated | Terminated | | Content | Loading | Loading | | Content | Content | Content* | | Content | Error | Error | | Content | Terminated | Terminated | | Error | Loading | Error | | Error | Content | Error | | Error | Error | Error | | Error | Terminated | Terminated | | Terminated | Loading | Terminated | | Terminated | Content | Terminated | | Terminated | Error | Terminated | | Terminated | Terminated | Terminated | | +| [map](map.md) | [common]
inline fun <[DATA_1](map.md) : Any, [DATA_2](map.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceState](-lce-state/index.md)<[DATA_2](map.md)>
Maps data in LceState | +| [mapEmptyData](map-empty-data.md) | [common]
inline fun <[DATA](map-empty-data.md) : Any> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>.[mapEmptyData](map-empty-data.md)(crossinline block: ([LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>) -> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>): [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>
Substitutes a state with empty data with empty data with state produced by [block](map-empty-data.md) | +| [mapEmptyDataItem](map-empty-data-item.md) | [common]
inline fun <[DATA](map-empty-data-item.md) : Any> [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)>.[mapEmptyDataItem](map-empty-data-item.md)(crossinline block: () -> [DATA](map-empty-data-item.md)?): [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)>
Substitutes an item in a state with empty data with item produced by [block](map-empty-data-item.md) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data-item.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data-item.md index 97cd2b21..8f631864 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data-item.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data-item.md @@ -3,7 +3,7 @@ # mapEmptyDataItem [common]\ -inline fun <[DATA](map-empty-data-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)>.[mapEmptyDataItem](map-empty-data-item.md)(crossinline block: () -> [DATA](map-empty-data-item.md)?): [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)> +inline fun <[DATA](map-empty-data-item.md) : Any> [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)>.[mapEmptyDataItem](map-empty-data-item.md)(crossinline block: () -> [DATA](map-empty-data-item.md)?): [LceState](-lce-state/index.md)<[DATA](map-empty-data-item.md)> Substitutes an item in a state with empty data with item produced by [block](map-empty-data-item.md) diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data.md index dd641282..4e2fbf49 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data.md @@ -3,7 +3,7 @@ # mapEmptyData [common]\ -inline fun <[DATA](map-empty-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>.[mapEmptyData](map-empty-data.md)(crossinline block: ([LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>) -> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>): [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)> +inline fun <[DATA](map-empty-data.md) : Any> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>.[mapEmptyData](map-empty-data.md)(crossinline block: ([LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>) -> [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)>): [LceState](-lce-state/index.md)<[DATA](map-empty-data.md)> Substitutes a state with empty data with empty data with state produced by [block](map-empty-data.md) diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/map.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/map.md index 2c465728..347f05a2 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/map.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/map.md @@ -3,7 +3,7 @@ # map [common]\ -inline fun <[DATA_1](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceState](-lce-state/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceState](-lce-state/index.md)<[DATA_2](map.md)> +inline fun <[DATA_1](map.md) : Any, [DATA_2](map.md) : Any> [LceState](-lce-state/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceState](-lce-state/index.md)<[DATA_2](map.md)> Maps data in LceState diff --git a/docs/package-list b/docs/package-list index f910d23d..419f8888 100644 --- a/docs/package-list +++ b/docs/package-list @@ -241,6 +241,7 @@ $dokka.location:com.motorro.rxlcemodel.kserializer/KotlinCacheDelegateSerializer $dokka.location:com.motorro.rxlcemodel.lce////PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/index.md $dokka.location:com.motorro.rxlcemodel.lce//catchToLce/com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])],com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/catch-to-lce.md $dokka.location:com.motorro.rxlcemodel.lce//combine/com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function2[TypeParam(bounds=[kotlin.Any])?,TypeParam(bounds=[kotlin.Any])?,TypeParam(bounds=[kotlin.Any])?]/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/combine.md +$dokka.location:com.motorro.rxlcemodel.lce//flatMap/com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[TypeParam(bounds=[kotlin.Any]),com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md $dokka.location:com.motorro.rxlcemodel.lce//map/com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/map.md $dokka.location:com.motorro.rxlcemodel.lce//mapEmptyData/com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])],com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data.md $dokka.location:com.motorro.rxlcemodel.lce//mapEmptyDataItem/com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function0[TypeParam(bounds=[kotlin.Any])?]/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/map-empty-data-item.md diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/index.md index cb3e43b4..f78136ea 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/index.md @@ -3,7 +3,7 @@ # LceStateView [androidJvm]\ -interface [LceStateView](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> +interface [LceStateView](index.md)<[DATA](index.md) : Any> Load-Content-View interface. @@ -20,19 +20,19 @@ androidJvm | Name | Summary | |---|---| | [getLifecycleOwner](get-lifecycle-owner.md) | [androidJvm]
abstract fun [getLifecycleOwner](get-lifecycle-owner.md)(): [LifecycleOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/LifecycleOwner.html)
Returns lifecycle owner | -| [isFatal](is-fatal.md) | [androidJvm]
open fun [isFatal](is-fatal.md)(error: [LceState.Error](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](index.md)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Checks if error is fatal for this view | +| [isFatal](is-fatal.md) | [androidJvm]
open fun [isFatal](is-fatal.md)(error: [LceState.Error](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](index.md)>): Boolean
Checks if error is fatal for this view | | [processState](process-state.md) | [androidJvm]
open fun [processState](process-state.md)(state: [LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>)
Call to process view state and data whenever new state arrives from model | -| [processStateData](process-state-data.md) | [androidJvm]
open fun [processStateData](process-state-data.md)(data: [DATA](index.md), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isUpdating: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html))
Called by [processState](process-state.md) to process new data. | +| [processStateData](process-state-data.md) | [androidJvm]
open fun [processStateData](process-state-data.md)(data: [DATA](index.md), isValid: Boolean, isUpdating: Boolean)
Called by [processState](process-state.md) to process new data. | | [processStateView](process-state-view.md) | [androidJvm]
open fun [processStateView](process-state-view.md)(state: [LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>)
Updates view according to [state](process-state-view.md) | | [processTermination](process-termination.md) | [androidJvm]
open fun [processTermination](process-termination.md)()
Process [LceState.Terminated](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-terminated/index.md). | | [showContent](show-content.md) | [androidJvm]
abstract fun [showContent](show-content.md)()
Displays content. | -| [showError](show-error.md) | [androidJvm]
abstract fun [showError](show-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html))
Displays error when there is no data to display. | +| [showError](show-error.md) | [androidJvm]
abstract fun [showError](show-error.md)(error: Throwable)
Displays error when there is no data to display. | | [showLoading](show-loading.md) | [androidJvm]
abstract fun [showLoading](show-loading.md)()
Displays loading when no data available. | -| [showNonFatalError](show-non-fatal-error.md) | [androidJvm]
open fun [showNonFatalError](show-non-fatal-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html))
Displays some error notification when the error is non-critical and some content may be displayed. | +| [showNonFatalError](show-non-fatal-error.md) | [androidJvm]
open fun [showNonFatalError](show-non-fatal-error.md)(error: Throwable)
Displays some error notification when the error is non-critical and some content may be displayed. | | [showRefreshing](show-refreshing.md) | [androidJvm]
open fun [showRefreshing](show-refreshing.md)(type: [LceState.Loading.Type](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/index.md))
Displays data refresh on top of current state. | ## Extensions | Name | Summary | |---|---| -| [initializeModel](../initialize-model.md) | [androidJvm]
inline fun <[DATA](../initialize-model.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [MODEL](../initialize-model.md) : [BaseLceModel](../../com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](../initialize-model.md)>> [LceStateView](index.md)<[DATA](../initialize-model.md)>.[initializeModel](../initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html), init: [MODEL](../initialize-model.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { initialize() }): [MODEL](../initialize-model.md)
Creates and initializes LCE view-model subscribing to state updates. | +| [initializeModel](../initialize-model.md) | [androidJvm]
inline fun <[DATA](../initialize-model.md) : Any, [MODEL](../initialize-model.md) : [BaseLceModel](../../com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](../initialize-model.md)>> [LceStateView](index.md)<[DATA](../initialize-model.md)>.[initializeModel](../initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html), init: [MODEL](../initialize-model.md).() -> Unit = { initialize() }): [MODEL](../initialize-model.md)
Creates and initializes LCE view-model subscribing to state updates. | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/is-fatal.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/is-fatal.md index 66df664f..29486fe3 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/is-fatal.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/is-fatal.md @@ -3,6 +3,6 @@ # isFatal [androidJvm]\ -open fun [isFatal](is-fatal.md)(error: [LceState.Error](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](index.md)>): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) +open fun [isFatal](is-fatal.md)(error: [LceState.Error](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](index.md)>): Boolean Checks if error is fatal for this view diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/process-state-data.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/process-state-data.md index 6693a91a..b4ea6718 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/process-state-data.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/process-state-data.md @@ -3,6 +3,6 @@ # processStateData [androidJvm]\ -open fun [processStateData](process-state-data.md)(data: [DATA](index.md), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), isUpdating: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) +open fun [processStateData](process-state-data.md)(data: [DATA](index.md), isValid: Boolean, isUpdating: Boolean) Called by [processState](process-state.md) to process new data. diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-error.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-error.md index f118fe5e..fb8770b9 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-error.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-error.md @@ -3,7 +3,7 @@ # showError [androidJvm]\ -abstract fun [showError](show-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) +abstract fun [showError](show-error.md)(error: Throwable) Displays error when there is no data to display. diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-non-fatal-error.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-non-fatal-error.md index ab2dcc80..dba84b0c 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-non-fatal-error.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/-lce-state-view/show-non-fatal-error.md @@ -3,7 +3,7 @@ # showNonFatalError [androidJvm]\ -open fun [showNonFatalError](show-non-fatal-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) +open fun [showNonFatalError](show-non-fatal-error.md)(error: Throwable) Displays some error notification when the error is non-critical and some content may be displayed. diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/index.md index f1ae042b..469c4f55 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/index.md @@ -6,10 +6,10 @@ | Name | Summary | |---|---| -| [LceStateView](-lce-state-view/index.md) | [androidJvm]
interface [LceStateView](-lce-state-view/index.md)<[DATA](-lce-state-view/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Load-Content-View interface. | +| [LceStateView](-lce-state-view/index.md) | [androidJvm]
interface [LceStateView](-lce-state-view/index.md)<[DATA](-lce-state-view/index.md) : Any>
Load-Content-View interface. | ## Functions | Name | Summary | |---|---| -| [initializeModel](initialize-model.md) | [androidJvm]
inline fun <[DATA](initialize-model.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [MODEL](initialize-model.md) : [BaseLceModel](../com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [LceStateView](-lce-state-view/index.md)<[DATA](initialize-model.md)>.[initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html), init: [MODEL](initialize-model.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { initialize() }): [MODEL](initialize-model.md)
Creates and initializes LCE view-model subscribing to state updates. | +| [initializeModel](initialize-model.md) | [androidJvm]
inline fun <[DATA](initialize-model.md) : Any, [MODEL](initialize-model.md) : [BaseLceModel](../com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [LceStateView](-lce-state-view/index.md)<[DATA](initialize-model.md)>.[initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html), init: [MODEL](initialize-model.md).() -> Unit = { initialize() }): [MODEL](initialize-model.md)
Creates and initializes LCE view-model subscribing to state updates. | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/initialize-model.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/initialize-model.md index bba8f2ea..f0abc6e5 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/initialize-model.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/initialize-model.md @@ -3,7 +3,7 @@ # initializeModel [androidJvm]\ -inline fun <[DATA](initialize-model.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [MODEL](initialize-model.md) : [BaseLceModel](../com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [LceStateView](-lce-state-view/index.md)<[DATA](initialize-model.md)>.[initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html), init: [MODEL](initialize-model.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) = { initialize() }): [MODEL](initialize-model.md) +inline fun <[DATA](initialize-model.md) : Any, [MODEL](initialize-model.md) : [BaseLceModel](../com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [LceStateView](-lce-state-view/index.md)<[DATA](initialize-model.md)>.[initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html), init: [MODEL](initialize-model.md).() -> Unit = { initialize() }): [MODEL](initialize-model.md) Creates and initializes LCE view-model subscribing to state updates. diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/-unhandled-exception.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/-unhandled-exception.md index 612984ab..60cc594d 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/-unhandled-exception.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/-unhandled-exception.md @@ -3,7 +3,7 @@ # UnhandledException [androidJvm]\ -fun [UnhandledException](-unhandled-exception.md)(cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) +fun [UnhandledException](-unhandled-exception.md)(cause: Throwable, message: String? = null) #### Parameters diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/index.md index df26a6b4..020312da 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/-unhandled-exception/index.md @@ -3,7 +3,7 @@ # UnhandledException [androidJvm]\ -class [UnhandledException](index.md)(cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) : [RuntimeException](https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html) +class [UnhandledException](index.md)(cause: Throwable, message: String? = null) : [RuntimeException](https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html) Exception to re-throw in LCE subscription if it was not routed through Error state @@ -20,24 +20,24 @@ androidJvm | | | |---|---| -| [UnhandledException](-unhandled-exception.md) | [androidJvm]
fun [UnhandledException](-unhandled-exception.md)(cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) | +| [UnhandledException](-unhandled-exception.md) | [androidJvm]
fun [UnhandledException](-unhandled-exception.md)(cause: Throwable, message: String? = null) | ## Functions | Name | Summary | |---|---| -| [addSuppressed](index.md#282858770%2FFunctions%2F1456247564) | [androidJvm]
fun [addSuppressed](index.md#282858770%2FFunctions%2F1456247564)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | -| [fillInStackTrace](index.md#-1102069925%2FFunctions%2F1456247564) | [androidJvm]
open fun [fillInStackTrace](index.md#-1102069925%2FFunctions%2F1456247564)(): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | -| [getLocalizedMessage](index.md#1043865560%2FFunctions%2F1456247564) | [androidJvm]
open fun [getLocalizedMessage](index.md#1043865560%2FFunctions%2F1456247564)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [getStackTrace](index.md#2050903719%2FFunctions%2F1456247564) | [androidJvm]
open fun [getStackTrace](index.md#2050903719%2FFunctions%2F1456247564)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | -| [getSuppressed](index.md#672492560%2FFunctions%2F1456247564) | [androidJvm]
fun [getSuppressed](index.md#672492560%2FFunctions%2F1456247564)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)> | -| [initCause](index.md#-418225042%2FFunctions%2F1456247564) | [androidJvm]
open fun [initCause](index.md#-418225042%2FFunctions%2F1456247564)(p0: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [addSuppressed](index.md#282858770%2FFunctions%2F1456247564) | [androidJvm]
fun [addSuppressed](index.md#282858770%2FFunctions%2F1456247564)(p0: Throwable) | +| [fillInStackTrace](index.md#-1102069925%2FFunctions%2F1456247564) | [androidJvm]
open fun [fillInStackTrace](index.md#-1102069925%2FFunctions%2F1456247564)(): Throwable | +| [getLocalizedMessage](index.md#1043865560%2FFunctions%2F1456247564) | [androidJvm]
open fun [getLocalizedMessage](index.md#1043865560%2FFunctions%2F1456247564)(): String | +| [getStackTrace](index.md#2050903719%2FFunctions%2F1456247564) | [androidJvm]
open fun [getStackTrace](index.md#2050903719%2FFunctions%2F1456247564)(): Array<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)> | +| [getSuppressed](index.md#672492560%2FFunctions%2F1456247564) | [androidJvm]
fun [getSuppressed](index.md#672492560%2FFunctions%2F1456247564)(): Array<Throwable> | +| [initCause](index.md#-418225042%2FFunctions%2F1456247564) | [androidJvm]
open fun [initCause](index.md#-418225042%2FFunctions%2F1456247564)(p0: Throwable): Throwable | | [printStackTrace](index.md#-1769529168%2FFunctions%2F1456247564) | [androidJvm]
open fun [printStackTrace](index.md#-1769529168%2FFunctions%2F1456247564)()
open fun [printStackTrace](index.md#1841853697%2FFunctions%2F1456247564)(p0: [PrintStream](https://developer.android.com/reference/kotlin/java/io/PrintStream.html))
open fun [printStackTrace](index.md#1175535278%2FFunctions%2F1456247564)(p0: [PrintWriter](https://developer.android.com/reference/kotlin/java/io/PrintWriter.html)) | -| [setStackTrace](index.md#2135801318%2FFunctions%2F1456247564) | [androidJvm]
open fun [setStackTrace](index.md#2135801318%2FFunctions%2F1456247564)(p0: [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | +| [setStackTrace](index.md#2135801318%2FFunctions%2F1456247564) | [androidJvm]
open fun [setStackTrace](index.md#2135801318%2FFunctions%2F1456247564)(p0: Array<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | ## Properties | Name | Summary | |---|---| -| [cause](index.md#-654012527%2FProperties%2F1456247564) | [androidJvm]
open val [cause](index.md#-654012527%2FProperties%2F1456247564): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)? | -| [message](index.md#1824300659%2FProperties%2F1456247564) | [androidJvm]
open val [message](index.md#1824300659%2FProperties%2F1456247564): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? | +| [cause](index.md#-654012527%2FProperties%2F1456247564) | [androidJvm]
open val [cause](index.md#-654012527%2FProperties%2F1456247564): Throwable? | +| [message](index.md#1824300659%2FProperties%2F1456247564) | [androidJvm]
open val [message](index.md#1824300659%2FProperties%2F1456247564): String? | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/index.md index c647f3bb..c26507c1 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel.error/index.md @@ -6,4 +6,4 @@ | Name | Summary | |---|---| -| [UnhandledException](-unhandled-exception/index.md) | [androidJvm]
class [UnhandledException](-unhandled-exception/index.md)(cause: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null) : [RuntimeException](https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html)
Exception to re-throw in LCE subscription if it was not routed through Error state | +| [UnhandledException](-unhandled-exception/index.md) | [androidJvm]
class [UnhandledException](-unhandled-exception/index.md)(cause: Throwable, message: String? = null) : [RuntimeException](https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html)
Exception to re-throw in LCE subscription if it was not routed through Error state | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/create.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/create.md index 73e47ede..2af429a3 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/create.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/create.md @@ -3,7 +3,7 @@ # create [androidJvm]\ -fun <[DATA](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [create](create.md)(stateObservable: Observable<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](create.md)>>, refresh: Completable): [BaseLceModel](../index.md)<[DATA](create.md)> +fun <[DATA](create.md) : Any> [create](create.md)(stateObservable: Observable<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](create.md)>>, refresh: Completable): [BaseLceModel](../index.md)<[DATA](create.md)> Creates LCE model @@ -17,7 +17,7 @@ androidJvm | refresh | Refresh operation | [androidJvm]\ -fun <[DATA](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [create](create.md)(useCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](create.md)>): [BaseLceModel](../index.md)<[DATA](create.md)> +fun <[DATA](create.md) : Any> [create](create.md)(useCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](create.md)>): [BaseLceModel](../index.md)<[DATA](create.md)> Creates LCE model diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/index.md index 073649df..6dc26a30 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-companion/index.md @@ -9,4 +9,4 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [create](create.md) | [androidJvm]
fun <[DATA](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [create](create.md)(useCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](create.md)>): [BaseLceModel](../index.md)<[DATA](create.md)>
fun <[DATA](create.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [create](create.md)(stateObservable: Observable<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](create.md)>>, refresh: Completable): [BaseLceModel](../index.md)<[DATA](create.md)>
Creates LCE model | +| [create](create.md) | [androidJvm]
fun <[DATA](create.md) : Any> [create](create.md)(useCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](create.md)>): [BaseLceModel](../index.md)<[DATA](create.md)>
fun <[DATA](create.md) : Any> [create](create.md)(stateObservable: Observable<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](create.md)>>, refresh: Completable): [BaseLceModel](../index.md)<[DATA](create.md)>
Creates LCE model | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/index.md index 82eff29a..a2d4dd3b 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/index.md @@ -3,7 +3,7 @@ # Impl [androidJvm]\ -abstract class [Impl](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [BaseLceModel](../index.md)<[DATA](index.md)> +abstract class [Impl](index.md)<[DATA](index.md) : Any> : [BaseLceModel](../index.md)<[DATA](index.md)> Basic ViewModel with LceModel inside @@ -19,7 +19,7 @@ Basic ViewModel with LceModel inside |---|---| | [addCloseable](../../-base-view-model/index.md#264516373%2FFunctions%2F1456247564) | [androidJvm]
open fun [addCloseable](../../-base-view-model/index.md#264516373%2FFunctions%2F1456247564)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)p0: [Closeable](https://developer.android.com/reference/kotlin/java/io/Closeable.html)) | | [dismissCurrentError](../dismiss-current-error.md) | [androidJvm]
fun [dismissCurrentError](../dismiss-current-error.md)()
Dismisses error set in state if it is error | -| [dismissError](../dismiss-error.md) | [androidJvm]
open fun [dismissError](../dismiss-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html))
Default action on critical error | +| [dismissError](../dismiss-error.md) | [androidJvm]
open fun [dismissError](../dismiss-error.md)(error: Throwable)
Default action on critical error | | [doClear](do-clear.md) | [androidJvm]
open override fun [doClear](do-clear.md)()
Disposes active operations when model is destroyed | | [initialize](../../-base-view-model/initialize.md) | [androidJvm]
fun [initialize](../../-base-view-model/initialize.md)()
Call this function to initialize a new model and start receiving events | | [refresh](refresh.md) | [androidJvm]
open override fun [refresh](refresh.md)()
Requests data refresh | @@ -29,8 +29,8 @@ Basic ViewModel with LceModel inside | Name | Summary | |---|---| -| [cleared](../../-base-view-model/cleared.md) | [androidJvm]
var [cleared](../../-base-view-model/cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is model cleared | -| [initialized](../../-base-view-model/initialized.md) | [androidJvm]
var [initialized](../../-base-view-model/initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is model initialized | +| [cleared](../../-base-view-model/cleared.md) | [androidJvm]
var [cleared](../../-base-view-model/cleared.md): Boolean
Is model cleared | +| [initialized](../../-base-view-model/initialized.md) | [androidJvm]
var [initialized](../../-base-view-model/initialized.md): Boolean
Is model initialized | | [state](state.md) | [androidJvm]
open override val [state](state.md): [LiveData](https://developer.android.com/reference/kotlin/androidx/lifecycle/LiveData.html)<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
LCE State | ## Inheritors diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/-with-updates.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/-with-updates.md index 94ce0d17..aeec5c7a 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/-with-updates.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/-with-updates.md @@ -3,7 +3,7 @@ # WithUpdates [androidJvm]\ -fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [WithUpdates](-with-updates.md)(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) +fun <[DATA](index.md) : Any> [WithUpdates](-with-updates.md)(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) #### Parameters diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/index.md index 273ea7a5..dc6bb1fd 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-with-updates/index.md @@ -3,7 +3,7 @@ # WithUpdates [androidJvm]\ -open class [WithUpdates](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) : [BaseLceModel.Impl](../-impl/index.md)<[DATA](index.md)> +open class [WithUpdates](index.md)<[DATA](index.md) : Any>(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) : [BaseLceModel.Impl](../-impl/index.md)<[DATA](index.md)> View model with operations that mix with commonMain state @@ -19,7 +19,7 @@ androidJvm | | | |---|---| -| [WithUpdates](-with-updates.md) | [androidJvm]
fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [WithUpdates](-with-updates.md)(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) | +| [WithUpdates](-with-updates.md) | [androidJvm]
fun <[DATA](index.md) : Any> [WithUpdates](-with-updates.md)(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) | ## Functions @@ -27,7 +27,7 @@ androidJvm |---|---| | [addCloseable](../../-base-view-model/index.md#264516373%2FFunctions%2F1456247564) | [androidJvm]
open fun [addCloseable](../../-base-view-model/index.md#264516373%2FFunctions%2F1456247564)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)p0: [Closeable](https://developer.android.com/reference/kotlin/java/io/Closeable.html)) | | [dismissCurrentError](../dismiss-current-error.md) | [androidJvm]
fun [dismissCurrentError](../dismiss-current-error.md)()
Dismisses error set in state if it is error | -| [dismissError](../dismiss-error.md) | [androidJvm]
open fun [dismissError](../dismiss-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html))
Default action on critical error | +| [dismissError](../dismiss-error.md) | [androidJvm]
open fun [dismissError](../dismiss-error.md)(error: Throwable)
Default action on critical error | | [doClear](../-impl/do-clear.md) | [androidJvm]
open override fun [doClear](../-impl/do-clear.md)()
Disposes active operations when model is destroyed | | [initialize](../../-base-view-model/initialize.md) | [androidJvm]
fun [initialize](../../-base-view-model/initialize.md)()
Call this function to initialize a new model and start receiving events | | [refresh](../-impl/refresh.md) | [androidJvm]
open override fun [refresh](../-impl/refresh.md)()
Requests data refresh | @@ -37,6 +37,6 @@ androidJvm | Name | Summary | |---|---| -| [cleared](../../-base-view-model/cleared.md) | [androidJvm]
var [cleared](../../-base-view-model/cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is model cleared | -| [initialized](../../-base-view-model/initialized.md) | [androidJvm]
var [initialized](../../-base-view-model/initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is model initialized | +| [cleared](../../-base-view-model/cleared.md) | [androidJvm]
var [cleared](../../-base-view-model/cleared.md): Boolean
Is model cleared | +| [initialized](../../-base-view-model/initialized.md) | [androidJvm]
var [initialized](../../-base-view-model/initialized.md): Boolean
Is model initialized | | [state](../-impl/state.md) | [androidJvm]
open override val [state](../-impl/state.md): [LiveData](https://developer.android.com/reference/kotlin/androidx/lifecycle/LiveData.html)<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
LCE State | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/dismiss-error.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/dismiss-error.md index 09053ec2..db2965d6 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/dismiss-error.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/dismiss-error.md @@ -3,7 +3,7 @@ # dismissError [androidJvm]\ -open fun [dismissError](dismiss-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) +open fun [dismissError](dismiss-error.md)(error: Throwable) Default action on critical error diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md index 76115f25..0c906d14 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md @@ -3,7 +3,7 @@ # BaseLceModel [androidJvm]\ -abstract class [BaseLceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [BaseViewModel](../-base-view-model/index.md) +abstract class [BaseLceModel](index.md)<[DATA](index.md) : Any> : [BaseViewModel](../-base-view-model/index.md) Base model with [state](state.md) and [refresh](refresh.md) @@ -18,8 +18,8 @@ Base model with [state](state.md) and [refresh](refresh.md) | Name | Summary | |---|---| | [Companion](-companion/index.md) | [androidJvm]
object [Companion](-companion/index.md) | -| [Impl](-impl/index.md) | [androidJvm]
abstract class [Impl](-impl/index.md)<[DATA](-impl/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [BaseLceModel](index.md)<[DATA](-impl/index.md)>
Basic ViewModel with LceModel inside | -| [WithUpdates](-with-updates/index.md) | [androidJvm]
open class [WithUpdates](-with-updates/index.md)<[DATA](-with-updates/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(dataUseCase: [LceUseCase](../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](-with-updates/index.md)>) : [BaseLceModel.Impl](-impl/index.md)<[DATA](-with-updates/index.md)>
View model with operations that mix with commonMain state | +| [Impl](-impl/index.md) | [androidJvm]
abstract class [Impl](-impl/index.md)<[DATA](-impl/index.md) : Any> : [BaseLceModel](index.md)<[DATA](-impl/index.md)>
Basic ViewModel with LceModel inside | +| [WithUpdates](-with-updates/index.md) | [androidJvm]
open class [WithUpdates](-with-updates/index.md)<[DATA](-with-updates/index.md) : Any>(dataUseCase: [LceUseCase](../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](-with-updates/index.md)>) : [BaseLceModel.Impl](-impl/index.md)<[DATA](-with-updates/index.md)>
View model with operations that mix with commonMain state | ## Functions @@ -27,7 +27,7 @@ Base model with [state](state.md) and [refresh](refresh.md) |---|---| | [addCloseable](../-base-view-model/index.md#264516373%2FFunctions%2F1456247564) | [androidJvm]
open fun [addCloseable](../-base-view-model/index.md#264516373%2FFunctions%2F1456247564)(@[NonNull](https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html)p0: [Closeable](https://developer.android.com/reference/kotlin/java/io/Closeable.html)) | | [dismissCurrentError](dismiss-current-error.md) | [androidJvm]
fun [dismissCurrentError](dismiss-current-error.md)()
Dismisses error set in state if it is error | -| [dismissError](dismiss-error.md) | [androidJvm]
open fun [dismissError](dismiss-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html))
Default action on critical error | +| [dismissError](dismiss-error.md) | [androidJvm]
open fun [dismissError](dismiss-error.md)(error: Throwable)
Default action on critical error | | [doClear](../-base-view-model/do-clear.md) | [androidJvm]
abstract fun [doClear](../-base-view-model/do-clear.md)()
Disposes active operations when model is destroyed | | [initialize](../-base-view-model/initialize.md) | [androidJvm]
fun [initialize](../-base-view-model/initialize.md)()
Call this function to initialize a new model and start receiving events | | [refresh](refresh.md) | [androidJvm]
abstract fun [refresh](refresh.md)()
Requests data refresh | @@ -37,8 +37,8 @@ Base model with [state](state.md) and [refresh](refresh.md) | Name | Summary | |---|---| -| [cleared](../-base-view-model/cleared.md) | [androidJvm]
var [cleared](../-base-view-model/cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Is model cleared | -| [initialized](../-base-view-model/initialized.md) | [androidJvm]
var [initialized](../-base-view-model/initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Is model initialized | +| [cleared](../-base-view-model/cleared.md) | [androidJvm]
var [cleared](../-base-view-model/cleared.md): Boolean = false
Is model cleared | +| [initialized](../-base-view-model/initialized.md) | [androidJvm]
var [initialized](../-base-view-model/initialized.md): Boolean = false
Is model initialized | | [state](state.md) | [androidJvm]
abstract val [state](state.md): [LiveData](https://developer.android.com/reference/kotlin/androidx/lifecycle/LiveData.html)<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
LCE State | ## Inheritors diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/cleared.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/cleared.md index 725b1eec..adf98876 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/cleared.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/cleared.md @@ -3,6 +3,6 @@ # cleared [androidJvm]\ -var [cleared](cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false +var [cleared](cleared.md): Boolean = false Is model cleared diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/index.md index 002fbf84..608dad43 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/index.md @@ -25,8 +25,8 @@ Base view model with [initialize](initialize.md) and [doClear](do-clear.md) meth | Name | Summary | |---|---| -| [cleared](cleared.md) | [androidJvm]
var [cleared](cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Is model cleared | -| [initialized](initialized.md) | [androidJvm]
var [initialized](initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false
Is model initialized | +| [cleared](cleared.md) | [androidJvm]
var [cleared](cleared.md): Boolean = false
Is model cleared | +| [initialized](initialized.md) | [androidJvm]
var [initialized](initialized.md): Boolean = false
Is model initialized | ## Inheritors diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/initialized.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/initialized.md index 81dfff9e..1e0807cb 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/initialized.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/initialized.md @@ -3,6 +3,6 @@ # initialized [androidJvm]\ -var [initialized](initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = false +var [initialized](initialized.md): Boolean = false Is model initialized diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/index.md index 309abd39..c47cb2aa 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/index.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/index.md @@ -6,5 +6,5 @@ | Name | Summary | |---|---| -| [BaseLceModel](-base-lce-model/index.md) | [androidJvm]
abstract class [BaseLceModel](-base-lce-model/index.md)<[DATA](-base-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [BaseViewModel](-base-view-model/index.md)
Base model with [state](-base-lce-model/state.md) and [refresh](-base-lce-model/refresh.md) | +| [BaseLceModel](-base-lce-model/index.md) | [androidJvm]
abstract class [BaseLceModel](-base-lce-model/index.md)<[DATA](-base-lce-model/index.md) : Any> : [BaseViewModel](-base-view-model/index.md)
Base model with [state](-base-lce-model/state.md) and [refresh](-base-lce-model/refresh.md) | | [BaseViewModel](-base-view-model/index.md) | [androidJvm]
abstract class [BaseViewModel](-base-view-model/index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html)
Base view model with [initialize](-base-view-model/initialize.md) and [doClear](-base-view-model/do-clear.md) methods |