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 306745ff..9f6d28c4 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? = null): [EntityValidator](../-entity-validator/index.md) +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. @@ -19,4 +19,4 @@ common | | | |---|---| -| IllegalArgumentException | if serialized can't be deserialized | +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | 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 4a298c12..c21fe2db 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? = null): [EntityValidator](../-entity-validator/index.md) +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 @@ -19,4 +19,4 @@ common | | | |---|---| -| IllegalArgumentException | if serialized can't be deserialized | +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | 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 86c34fda..78b3b57a 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 @@ -2,20 +2,19 @@ # EntityValidatorFactory -[common]\ interface [EntityValidatorFactory](index.md) Cache-control [EntityValidator](../-entity-validator/index.md) factory for operations +#### Inheritors + +| | +|---| +| [LifespanValidatorFactory](../-lifespan-validator-factory/index.md) | + ## Functions | Name | Summary | |---|---| -| [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 - -| Name | -|---| -| [LifespanValidatorFactory](../-lifespan-validator-factory/index.md) | +| [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. | 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 bb04bbaa..072422e7 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): [EntityValidator](../../index.md)? +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 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 7e3e9e1a..5964aaff 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): [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 | +| [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 | 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 d2a6987e..322d6b22 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
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | +| [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 | 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 0ccac9f8..df7c29cb 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 +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. 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 bb7120de..8be14be6 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 +open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 13ab4a22..05e4430b 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): [EntityValidator](../index.md)? +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 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 1b16c6af..cc7a0e4c 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): [EntityValidator](../index.md)? +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 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 c6f5bc63..6244156b 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 @@ -2,23 +2,22 @@ # Deserializer -[common]\ interface [Deserializer](index.md) Deserializes validator from string -## Functions - -| Name | Summary | -|---|---| -| [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 +#### Inheritors -| Name | +| | |---| | [SimpleDeserializer](../-simple/-simple-deserializer/index.md) | | [AlwaysDeserializer](../-always/-always-deserializer/index.md) | | [NeverDeserializer](../-never/-never-deserializer/index.md) | | [LifespanDeserializer](../-lifespan/-lifespan-deserializer/index.md) | + +## Functions + +| 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 | 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 7f0abad5..5c8f54be 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, clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md) +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) 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 a5f735e4..9cd50bb6 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, 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](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) | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/-lifespan-deserializer.md b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/-lifespan-deserializer.md index dbeebc04..0830ad57 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/-lifespan-deserializer.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator/-lifespan/-lifespan-deserializer/-lifespan-deserializer.md @@ -3,4 +3,4 @@ # LifespanDeserializer [common]\ -fun [LifespanDeserializer](-lifespan-deserializer.md)(clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) +constructor(clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) 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 326fa1dd..d5ff72cc 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): [EntityValidator](../../index.md)? +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 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 04f930c3..49f33d28 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): [EntityValidator](../../index.md)? +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 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 b7931998..9a7d6860 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 @@ -11,7 +11,7 @@ Deserializes validator from string | | | |---|---| -| [LifespanDeserializer](-lifespan-deserializer.md) | [common]
fun [LifespanDeserializer](-lifespan-deserializer.md)(clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | +| [LifespanDeserializer](-lifespan-deserializer.md) | [common]
constructor(clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | ## Types @@ -23,5 +23,5 @@ Deserializes validator from string | Name | Summary | |---|---| -| [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 | +| [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 | 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 a370d774..7d8abdb3 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, clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) +constructor(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) #### 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 06362d03..32a0d043 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?): Boolean +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 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 27f91ef5..5f2513d5 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 +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 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 17c4c308..cc529d38 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 @@ -2,7 +2,6 @@ # Lifespan -[common]\ class [Lifespan](index.md) : [EntityValidator](../index.md) Uses creation time and TTL to validate @@ -21,7 +20,7 @@ common | | | |---|---| -| [Lifespan](-lifespan.md) | [common]
fun [Lifespan](-lifespan.md)(ttl: Long, clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | +| [Lifespan](-lifespan.md) | [common]
constructor(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) | ## Types @@ -35,8 +34,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?): 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 | +| [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 | 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 043da8d5..726f9415 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 +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. 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 db3a1120..f867c513 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 +open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 375d2b13..5a61fb3f 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 +open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 8e7a3253..a7091168 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): [EntityValidator](../../index.md)? +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 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 d68d8a45..21a0b477 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): [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 | +| [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 | 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 688d3618..4a2cd871 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
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | +| [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 | 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 0d5e5a98..71176cf2 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 +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. 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 0c15ade7..8fb6e6da 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 +open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 09460ae9..05fc264e 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): [EntityValidator](../../index.md)? +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 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 e4718eaa..2b4be7ea 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): [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 | +| [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 | 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 f04f05ac..789c0d1a 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) +constructor(valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) #### 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 0ab6dd96..71824804 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 @@ -2,8 +2,7 @@ # Simple -[common]\ -data class [Simple](index.md)(valid: Boolean) : [EntityValidator](../index.md) +data class [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](is-valid.md) state of dynamic validator such as [Lifespan](../-lifespan/index.md) @@ -19,7 +18,7 @@ common | | | |---|---| -| [Simple](-simple.md) | [common]
fun [Simple](-simple.md)(valid: Boolean) | +| [Simple](-simple.md) | [common]
constructor(valid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | ## Types @@ -32,5 +31,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
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
open override fun [serialize](serialize.md)(): String
A way to serialize entity | +| [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 | 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 bddecbfc..4e7a2671 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 +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. 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 c071a961..dd978181 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 +open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 0d429d74..c53398bc 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 @@ -2,11 +2,21 @@ # EntityValidator -[common]\ interface [EntityValidator](index.md) Entity validator +#### Inheritors + +| | +|---| +| [Entity](../-entity/index.md) | +| [Impl](../-entity/-impl/index.md) | +| [Simple](-simple/index.md) | +| [Always](-always/index.md) | +| [Never](-never/index.md) | +| [Lifespan](-lifespan/index.md) | + ## Types | Name | Summary | @@ -15,23 +25,12 @@ 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) : [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](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) | ## 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
If true cached entity is valid. | -| [serialize](serialize.md) | [common]
abstract fun [serialize](serialize.md)(): String
A way to serialize entity | - -## Inheritors - -| Name | -|---| -| [Entity](../-entity/index.md) | -| [Impl](../-entity/-impl/index.md) | -| [Simple](-simple/index.md) | -| [Always](-always/index.md) | -| [Never](-never/index.md) | -| [Lifespan](-lifespan/index.md) | +| [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 | 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 3496905f..1e45a7ea 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 +abstract fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) 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 f0f7f959..c50f61f2 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 +abstract fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 55511ac2..e96b0b15 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> [Impl](-impl.md)(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) +constructor(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 9ca38e97..7739a968 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 @@ -2,8 +2,7 @@ # Impl -[common]\ -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) +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) Simple entity implementation @@ -20,19 +19,19 @@ common | | | |---|---| -| [Impl](-impl.md) | [common]
fun <out [T](index.md) : Any> [Impl](-impl.md)(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) | +| [Impl](-impl.md) | [common]
constructor(data: [T](index.md), validator: [EntityValidator](../../-entity-validator/index.md)) | -## Functions +## Properties | 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
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 | +| [data](data.md) | [common]
open override val [data](data.md): [T](index.md) | -## Properties +## Functions | Name | Summary | |---|---| -| [data](data.md) | [common]
open override val [data](data.md): [T](index.md) | +| [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 | 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 86ef59b6..62b6f1b8 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> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](../index.md)<[R](map.md)> +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 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 3963847e..96aabbc0 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 @@ -2,25 +2,21 @@ # Entity -[common]\ -interface [Entity](index.md)<out [T](index.md) : Any> : [EntityValidator](../-entity-validator/index.md) +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) Cache-controlling entity for [com.motorro.rxlcemodel.cache.entity.Entity](index.md) implement this interface for cache control -## Types +#### Inheritors -| Name | Summary | -|---|---| -| [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 | +| | +|---| +| [Impl](-impl/index.md) | -## Functions +## Types | 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
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 | +| [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 | ## Properties @@ -28,8 +24,11 @@ Cache-controlling entity for [com.motorro.rxlcemodel.cache.entity.Entity](index. |---|---| | [data](data.md) | [common]
abstract val [data](data.md): [T](index.md)
Entity data | -## Inheritors +## Functions -| Name | -|---| -| [Impl](-impl/index.md) | +| 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 | 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 ea2aacbc..6eb617ed 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> [map](map.md)(mapper: ([T](index.md)) -> [R](map.md)): [Entity](index.md)<[R](map.md)> +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 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 656c838c..5df899ab 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, clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) +constructor(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) #### 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 e98701e1..0c40c25a 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?): [EntityValidator](../-entity-validator/index.md) +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. @@ -19,4 +19,4 @@ common | | | |---|---| -| IllegalArgumentException | if serialized can't be deserialized | +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | 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 e0a5bf79..926c561c 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?): [EntityValidator](../-entity-validator/index.md) +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 @@ -19,4 +19,4 @@ common | | | |---|---| -| IllegalArgumentException | if serialized can't be deserialized | +| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | 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 318df78b..df79ca3a 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 @@ -2,8 +2,7 @@ # LifespanValidatorFactory -[common]\ -class [LifespanValidatorFactory](index.md)(cacheTtl: Long, clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [EntityValidatorFactory](../-entity-validator-factory/index.md) +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) Creates [Lifespan](../-entity-validator/-lifespan/index.md) as a cache-control @@ -20,11 +19,11 @@ common | | | |---|---| -| [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) | +| [LifespanValidatorFactory](-lifespan-validator-factory.md) | [common]
constructor(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) | ## Functions | Name | Summary | |---|---| -| [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. | +| [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. | 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 eb7f79a4..49a95fc4 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> : [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](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 | | [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, 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](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 | ## Functions | Name | Summary | |---|---| -| [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 | +| [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 | 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 ffe65b44..230b35a2 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> [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](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 diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/-with-object-stream.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/-with-object-stream.md index 2c8fd5d7..d3d8b9b3 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/-with-object-stream.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/-with-object-stream.md @@ -3,7 +3,7 @@ # WithObjectStream [jvm]\ -fun <[D](index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)> [WithObjectStream](-with-object-stream.md)(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](index.md)>) +constructor(validatorFactory: [EntityValidatorFactory](../../../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](index.md)>) #### Parameters @@ -11,5 +11,5 @@ jvm | | | |---|---| -| validatorFactory | [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | +| validatorFactory | [Entity](../../../com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | | dataClass | Class type to cast result to | 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 ddd87dc6..1a877de9 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,9 +3,9 @@ # 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, invalidated: Boolean): [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](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](../../../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 +Deserializes [Entity](../../../com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream #### Parameters 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 5183ae4b..1f6645a1 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 @@ -2,8 +2,7 @@ # WithObjectStream -[jvm]\ -class [WithObjectStream](index.md)<[D](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](index.md)>) : [CacheDelegateSerializerDeserializer](../index.md)<[D](index.md)> +class [WithObjectStream](index.md)<[D](index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)>(validatorFactory: [EntityValidatorFactory](../../../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](index.md)>) : [CacheDelegateSerializerDeserializer](../index.md)<[D](index.md)> Serializes and deserializes [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) objects @@ -13,18 +12,18 @@ jvm | | | |---|---| -| validatorFactory | [Entity](../../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | +| validatorFactory | [Entity](../../../com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | | dataClass | Class type to cast result to | ## Constructors | | | |---|---| -| [WithObjectStream](-with-object-stream.md) | [jvm]
fun <[D](index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)> [WithObjectStream](-with-object-stream.md)(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](index.md)>) | +| [WithObjectStream](-with-object-stream.md) | [jvm]
constructor(validatorFactory: [EntityValidatorFactory](../../../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](index.md)>) | ## 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, 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 | +| [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](../../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../../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](../../../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/-with-object-stream/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/serialize.md index 6ce99561..54ba4f77 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/-with-object-stream/serialize.md @@ -3,7 +3,7 @@ # serialize [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)) +open override fun [serialize](serialize.md)(entity: [Entity](../../../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 d9b3cc0e..42f18563 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,9 +3,9 @@ # deserializeSnapshot [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)>? +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](../../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 +Deserializes [Entity](../../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 #### Parameters 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 47d51f40..670ad9bb 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 @@ -2,27 +2,26 @@ # CacheDelegateSerializerDeserializer -[jvm]\ -interface [CacheDelegateSerializerDeserializer](index.md)<[D](index.md) : Any> +interface [CacheDelegateSerializerDeserializer](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Serializer for cache delegates +#### Inheritors + +| | +|---| +| [WithObjectStream](-with-object-stream/index.md) | +| [WithObjectStreamAndCacheKey](../-with-object-stream-and-cache-key/index.md) | + ## Types | Name | Summary | |---|---| -| [WithObjectStream](-with-object-stream/index.md) | [jvm]
class [WithObjectStream](-with-object-stream/index.md)<[D](-with-object-stream/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/index.md)>) : [CacheDelegateSerializerDeserializer](index.md)<[D](-with-object-stream/index.md)>
Serializes and deserializes [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) objects | +| [WithObjectStream](-with-object-stream/index.md) | [jvm]
class [WithObjectStream](-with-object-stream/index.md)<[D](-with-object-stream/index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)>(validatorFactory: [EntityValidatorFactory](../../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/index.md)>) : [CacheDelegateSerializerDeserializer](index.md)<[D](-with-object-stream/index.md)>
Serializes and deserializes [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) objects | ## Functions | 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, 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 - -| Name | -|---| -| [WithObjectStream](-with-object-stream/index.md) | -| [WithObjectStreamAndCacheKey](../-with-object-stream-and-cache-key/index.md) | +| [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](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Deserializes [Entity](../../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](../../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/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/serialize.md index 910d2673..feaa3603 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/serialize.md @@ -3,7 +3,7 @@ # serialize [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)) +abstract fun [serialize](serialize.md)(entity: [Entity](../../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/index.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md index 22cd2bd2..9787dff6 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 @@ -2,11 +2,17 @@ # CacheDelegate -[common]\ -interface [CacheDelegate](index.md)<[D](index.md) : Any, [P](index.md) : Any> +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)> Delegate that synchronously performs caching operations +#### Inheritors + +| | +|---| +| [CacheFriendDelegate](../-cache-friend-delegate/index.md) | +| [MemorySyncDelegate](../-memory-sync-delegate/index.md) | + ## Functions | Name | Summary | @@ -15,18 +21,6 @@ Delegate that synchronously performs caching operations | [get](get.md) | [common]
abstract fun [get](get.md)(params: [P](index.md)): [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Returns data if cached | | [invalidate](invalidate.md) | [common]
abstract fun [invalidate](invalidate.md)(params: [P](index.md))
Invalidates cached value | | [invalidateAll](invalidate-all.md) | [common]
abstract fun [invalidateAll](invalidate-all.md)()
Invalidates all cached values | +| [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 | | [save](save.md) | [common]
abstract fun [save](save.md)(params: [P](index.md), entity: [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>)
Saves data to cache | - -## Inheritors - -| Name | -|---| -| [CacheFriendDelegate](../-cache-friend-delegate/index.md) | -| [MemorySyncDelegate](../-memory-sync-delegate/index.md) | - -## Extensions - -| Name | Summary | -|---|---| -| [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 | +| [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 | 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 5f2bb416..4c7c4ac3 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, [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)>) +constructor(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 82834255..1320e37f 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, [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](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)> 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, [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]
constructor(delegate: [CacheDelegate](../-cache-delegate/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>, [P](index.md)>) | ## Functions @@ -21,11 +21,6 @@ Wraps [delegate](../../../../cache/com.motorro.rxlcemodel.cache/-cache-friend-de | [get](get.md) | [common]
open override fun [get](get.md)(params: [P](index.md)): [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Returns data if cached | | [invalidate](invalidate.md) | [common]
open override fun [invalidate](invalidate.md)(params: [P](index.md))
Invalidates cached value | | [invalidateAll](invalidate-all.md) | [common]
open override fun [invalidateAll](invalidate-all.md)()
Invalidates all cached values | +| [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 | | [save](save.md) | [common]
open override fun [save](save.md)(params: [P](index.md), entity: [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>)
Saves data to cache | - -## Extensions - -| Name | Summary | -|---|---| -| [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 | +| [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 | 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 bdf76cc2..5c8b8940 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 +open val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) 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 37dd1fa4..497fe8b5 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
A cache key | +| [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 | 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 bbef2696..449f3cd1 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> [DataWithCacheKey](-data-with-cache-key.md)(data: [D](index.md), cacheKey: String) +constructor(data: [D](index.md), cacheKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) #### 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 e300f6f4..c4313561 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 +val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) #### 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 1856e717..50e66ddb 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 @@ -2,19 +2,10 @@ # DataWithCacheKey -[common]\ -data class [DataWithCacheKey](index.md)<[D](index.md) : Any>(val data: [D](index.md), val cacheKey: String) +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 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. -#### See also - -common - -| | -|---| -| [CacheFriendDelegate](../-cache-friend-delegate/index.md) | - #### Parameters common @@ -24,15 +15,21 @@ common | data | Original data | | cacheKey | Full unmodified cache key | +#### See also + +| | +|---| +| [CacheFriendDelegate](../-cache-friend-delegate/index.md) | + ## Constructors | | | |---|---| -| [DataWithCacheKey](-data-with-cache-key.md) | [common]
fun <[D](index.md) : Any> [DataWithCacheKey](-data-with-cache-key.md)(data: [D](index.md), cacheKey: String) | +| [DataWithCacheKey](-data-with-cache-key.md) | [common]
constructor(data: [D](index.md), cacheKey: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)) | ## Properties | Name | Summary | |---|---| -| [cacheKey](cache-key.md) | [common]
val [cacheKey](cache-key.md): String | +| [cacheKey](cache-key.md) | [common]
val [cacheKey](cache-key.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | | [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 cfb943f9..d29d281f 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, [P](create.md) : Any> [create](create.md)(maxEntries: Long): [MemorySyncDelegate](../index.md)<[D](create.md), [P](create.md)> +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. 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 893a72b9..57929630 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, [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. | +| [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. | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-memory-sync-delegate.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-memory-sync-delegate.md index 86ad063e..78889956 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-memory-sync-delegate.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-memory-sync-delegate/-memory-sync-delegate.md @@ -3,7 +3,7 @@ # MemorySyncDelegate [common]\ -fun [MemorySyncDelegate](-memory-sync-delegate.md)() +constructor() #### Parameters 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 08d11646..6dbc190a 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 @@ -2,8 +2,7 @@ # MemorySyncDelegate -[common]\ -abstract class [MemorySyncDelegate](index.md)<[D](index.md) : Any, [P](index.md) : Any> : [CacheDelegate](../-cache-delegate/index.md)<[D](index.md), [P](index.md)> +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)> A simple memory cache for cache-service @@ -20,7 +19,7 @@ common | | | |---|---| -| [MemorySyncDelegate](-memory-sync-delegate.md) | [common]
fun [MemorySyncDelegate](-memory-sync-delegate.md)() | +| [MemorySyncDelegate](-memory-sync-delegate.md) | [common]
constructor() | ## Types @@ -36,11 +35,6 @@ common | [get](get.md) | [common]
open override fun [get](get.md)(params: [P](index.md)): [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Returns data if cached | | [invalidate](invalidate.md) | [common]
open override fun [invalidate](invalidate.md)(params: [P](index.md))
Invalidates cached value | | [invalidateAll](invalidate-all.md) | [common]
open override fun [invalidateAll](invalidate-all.md)()
Invalidates all cached values | +| [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 | | [save](save.md) | [common]
open override fun [save](save.md)(params: [P](index.md), entity: [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>)
Saves data to cache | - -## Extensions - -| Name | Summary | -|---|---| -| [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 | +| [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 | diff --git a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/-with-object-stream-and-cache-key.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/-with-object-stream-and-cache-key.md index 8a728baa..1e6e91fd 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/-with-object-stream-and-cache-key.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/-with-object-stream-and-cache-key.md @@ -3,7 +3,7 @@ # WithObjectStreamAndCacheKey [jvm]\ -fun <[D](index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)> [WithObjectStreamAndCacheKey](-with-object-stream-and-cache-key.md)(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](index.md)>) +constructor(validatorFactory: [EntityValidatorFactory](../../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](index.md)>) #### Parameters @@ -11,5 +11,5 @@ jvm | | | |---|---| -| validatorFactory | [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | +| validatorFactory | [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | | dataClass | Class type to cast result to | 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 32505a5c..ba7e195e 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,9 +3,9 @@ # 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, 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)>>? +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](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../-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 +Deserializes [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md) from [input](deserialize-snapshot.md) stream #### Parameters 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 218f5c56..33be29f1 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 @@ -2,8 +2,7 @@ # WithObjectStreamAndCacheKey -[jvm]\ -class [WithObjectStreamAndCacheKey](index.md)<[D](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](index.md)>) : [CacheDelegateSerializerDeserializer](../-cache-delegate-serializer-deserializer/index.md)<[DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>> +class [WithObjectStreamAndCacheKey](index.md)<[D](index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)>(validatorFactory: [EntityValidatorFactory](../../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](index.md)>) : [CacheDelegateSerializerDeserializer](../-cache-delegate-serializer-deserializer/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>> Serializes and deserializes [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) objects along with their caching key @@ -13,18 +12,18 @@ jvm | | | |---|---| -| validatorFactory | [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | +| validatorFactory | [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md) validator factory | | dataClass | Class type to cast result to | ## Constructors | | | |---|---| -| [WithObjectStreamAndCacheKey](-with-object-stream-and-cache-key.md) | [jvm]
fun <[D](index.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)> [WithObjectStreamAndCacheKey](-with-object-stream-and-cache-key.md)(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](index.md)>) | +| [WithObjectStreamAndCacheKey](-with-object-stream-and-cache-key.md) | [jvm]
constructor(validatorFactory: [EntityValidatorFactory](../../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](index.md)>) | ## 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, 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 | +| [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](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../-data-with-cache-key/index.md)<[D](index.md)>>?
Deserializes [Entity](../../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](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../-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/-with-object-stream-and-cache-key/serialize.md b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/serialize.md index cb6c0cc5..c197f1bf 100644 --- a/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/serialize.md +++ b/docs/cache/cache/com.motorro.rxlcemodel.cache/-with-object-stream-and-cache-key/serialize.md @@ -3,7 +3,7 @@ # serialize [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)) +open override fun [serialize](serialize.md)(entity: [Entity](../../com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DataWithCacheKey](../-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 3cc003e0..97006d32 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, [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 | +| [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 | | [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, [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](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. | | [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>(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 | +| [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 | +| [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](../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](-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, [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 | +| [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 | 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 38498b5f..cb56caf2 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, [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)> +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 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 61128744..2c72f8f9 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, [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)> +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 diff --git a/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/-e-r-r-o-r.md b/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/-e-r-r-o-r.md index a42e8a16..1ab994ce 100644 --- a/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/-e-r-r-o-r.md +++ b/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/-e-r-r-o-r.md @@ -3,4 +3,4 @@ # ERROR [common]\ -fun [ERROR](-e-r-r-o-r.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) +constructor(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) diff --git a/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/index.md b/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/index.md index 22f59481..21760252 100644 --- a/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/index.md +++ b/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-e-r-r-o-r/index.md @@ -9,16 +9,16 @@ data class [ERROR](index.md)(val error: [Throwable](https://kotlinlang.org/api/l | | | |---|---| -| [ERROR](-e-r-r-o-r.md) | [common]
fun [ERROR](-e-r-r-o-r.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | +| [ERROR](-e-r-r-o-r.md) | [common]
constructor(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) | -## Functions +## Properties | Name | Summary | |---|---| -| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [error](error.md) | [common]
val [error](error.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | -## Properties +## Functions | Name | Summary | |---|---| -| [error](error.md) | [common]
val [error](error.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) | +| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | diff --git a/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/index.md b/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/index.md index 7725d896..e6411a13 100644 --- a/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/index.md +++ b/docs/common/common/com.motorro.rxlcemodel.common/-update-operation-state/index.md @@ -2,11 +2,18 @@ # UpdateOperationState -[common]\ sealed class [UpdateOperationState](index.md) Cache update operation state +#### Inheritors + +| | +|---| +| [IDLE](-i-d-l-e/index.md) | +| [LOADING](-l-o-a-d-i-n-g/index.md) | +| [ERROR](-e-r-r-o-r/index.md) | + ## Types | Name | Summary | @@ -14,11 +21,3 @@ Cache update operation state | [ERROR](-e-r-r-o-r/index.md) | [common]
data class [ERROR](-e-r-r-o-r/index.md)(val error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) : [UpdateOperationState](index.md) | | [IDLE](-i-d-l-e/index.md) | [common]
object [IDLE](-i-d-l-e/index.md) : [UpdateOperationState](index.md) | | [LOADING](-l-o-a-d-i-n-g/index.md) | [common]
object [LOADING](-l-o-a-d-i-n-g/index.md) : [UpdateOperationState](index.md) | - -## Inheritors - -| Name | -|---| -| [IDLE](-i-d-l-e/index.md) | -| [LOADING](-l-o-a-d-i-n-g/index.md) | -| [ERROR](-e-r-r-o-r/index.md) | diff --git a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/-swipe-refresh.md b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/-swipe-refresh.md index 801201c5..fe8ef09c 100644 --- a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/-swipe-refresh.md +++ b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/-swipe-refresh.md @@ -6,6 +6,6 @@ @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) -fun [SwipeRefresh](-swipe-refresh.md)(refreshing: Boolean, onRefresh: () -> Unit, content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> Unit) +fun [SwipeRefresh](-swipe-refresh.md)(refreshing: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), onRefresh: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)([Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) Swipe-refresh content wrapper diff --git a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/index.md b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/index.md index 1054625a..9bdfe0f5 100644 --- a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/index.md +++ b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview.view/index.md @@ -6,4 +6,4 @@ | Name | Summary | |---|---| -| [SwipeRefresh](-swipe-refresh.md) | [androidJvm]
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)
fun [SwipeRefresh](-swipe-refresh.md)(refreshing: Boolean, onRefresh: () -> Unit, content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> Unit)
Swipe-refresh content wrapper | +| [SwipeRefresh](-swipe-refresh.md) | [androidJvm]
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)
fun [SwipeRefresh](-swipe-refresh.md)(refreshing: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), onRefresh: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)([Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Swipe-refresh content wrapper | diff --git a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/-lce-state-view.md b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/-lce-state-view.md index edc8c6ad..7ea33d60 100644 --- a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/-lce-state-view.md +++ b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/-lce-state-view.md @@ -6,7 +6,7 @@ @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) -fun <[DATA](-lce-state-view.md) : Any> [LceStateView](-lce-state-view.md)(viewState: [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](-lce-state-view.md)>, onRefresh: () -> Unit, loading: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> Unit, fatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: Throwable) -> Unit, nonFatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: Throwable) -> Unit, termination: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> Unit, isFatalError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](-lce-state-view.md)>) -> Boolean = { null == it.data }, content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(data: [DATA](-lce-state-view.md), isValid: Boolean, refreshing: Boolean) -> Unit) +fun <[DATA](-lce-state-view.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceStateView](-lce-state-view.md)(viewState: [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](-lce-state-view.md)>, onRefresh: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), loading: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), fatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), nonFatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), termination: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), isFatalError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](-lce-state-view.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = { null == it.data }, content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(data: [DATA](-lce-state-view.md), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), refreshing: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)) Attaches composable view to view-model diff --git a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/index.md b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/index.md index 3d956e4e..0dc9c33f 100644 --- a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/index.md +++ b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/index.md @@ -6,5 +6,5 @@ | Name | Summary | |---|---| -| [initializeModel](initialize-model.md) | [androidJvm]
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)
inline fun <[DATA](initialize-model.md) : Any, [MODEL](initialize-model.md) : [BaseLceModel](../../../viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html) = checkNotNull(LocalViewModelStoreOwner.current) { "No ViewModelStoreOwner was provided via LocalViewModelStoreOwner" }, init: [MODEL](initialize-model.md).() -> Unit = { initialize() }): [MODEL](initialize-model.md)
Creates and initializes LCE view-model | -| [LceStateView](-lce-state-view.md) | [androidJvm]
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)
fun <[DATA](-lce-state-view.md) : Any> [LceStateView](-lce-state-view.md)(viewState: [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](-lce-state-view.md)>, onRefresh: () -> Unit, loading: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> Unit, fatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: Throwable) -> Unit, nonFatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: Throwable) -> Unit, termination: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> Unit, isFatalError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](-lce-state-view.md)>) -> Boolean = { null == it.data }, content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(data: [DATA](-lce-state-view.md), isValid: Boolean, refreshing: Boolean) -> Unit)
Attaches composable view to view-model | +| [initializeModel](initialize-model.md) | [androidJvm]
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)
inline fun <[DATA](initialize-model.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [MODEL](initialize-model.md) : [BaseLceModel](../../../viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html) = checkNotNull(LocalViewModelStoreOwner.current) { "No ViewModelStoreOwner was provided via LocalViewModelStoreOwner" }, 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 | +| [LceStateView](-lce-state-view.md) | [androidJvm]
@[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)
fun <[DATA](-lce-state-view.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceStateView](-lce-state-view.md)(viewState: [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](-lce-state-view.md)>, onRefresh: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), loading: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), fatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), nonFatalError: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), termination: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html), isFatalError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](-lce-state-view.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) = { null == it.data }, content: @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html)(data: [DATA](-lce-state-view.md), isValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html), refreshing: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html))
Attaches composable view to view-model | diff --git a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/initialize-model.md b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/initialize-model.md index 88f2096c..13d03b85 100644 --- a/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/initialize-model.md +++ b/docs/composeview/composeview/com.motorro.rxlcemodel.composeview/initialize-model.md @@ -6,8 +6,8 @@ @[Composable](https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable.html) -inline fun <[DATA](initialize-model.md) : Any, [MODEL](initialize-model.md) : [BaseLceModel](../../../viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html) = checkNotNull(LocalViewModelStoreOwner.current) { +inline fun <[DATA](initialize-model.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [MODEL](initialize-model.md) : [BaseLceModel](../../../viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/index.md)<[DATA](initialize-model.md)>> [initializeModel](initialize-model.md)(modelStoreOwner: [ViewModelStoreOwner](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModelStoreOwner.html) = checkNotNull(LocalViewModelStoreOwner.current) { "No ViewModelStoreOwner was provided via LocalViewModelStoreOwner" - }, init: [MODEL](initialize-model.md).() -> Unit = { initialize() }): [MODEL](initialize-model.md) + }, 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 diff --git a/docs/coroutines/coroutines/[root]/coroutines-run-catching.md b/docs/coroutines/coroutines/[root]/coroutines-run-catching.md new file mode 100644 index 00000000..c2cadd28 --- /dev/null +++ b/docs/coroutines/coroutines/[root]/coroutines-run-catching.md @@ -0,0 +1,8 @@ +//[coroutines](../../index.md)/[[root]](index.md)/[coroutinesRunCatching](coroutines-run-catching.md) + +# coroutinesRunCatching + +[common]\ +inline fun <[T](coroutines-run-catching.md), [R](coroutines-run-catching.md)> [T](coroutines-run-catching.md).[coroutinesRunCatching](coroutines-run-catching.md)(block: [T](coroutines-run-catching.md).() -> [R](coroutines-run-catching.md)): [Result](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/index.html)<[R](coroutines-run-catching.md)> + +Calls the specified function [block](coroutines-run-catching.md) with `this` value as its receiver and returns its encapsulated result if invocation was successful, catching any [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) exception besides CancellationException that was thrown from the [block](coroutines-run-catching.md) function execution and encapsulating it as a failure. diff --git a/docs/coroutines/coroutines/[root]/index.md b/docs/coroutines/coroutines/[root]/index.md new file mode 100644 index 00000000..a8d164a5 --- /dev/null +++ b/docs/coroutines/coroutines/[root]/index.md @@ -0,0 +1,9 @@ +//[coroutines](../../index.md)/[[root]](index.md) + +# Package-level declarations + +## Functions + +| Name | Summary | +|---|---| +| [coroutinesRunCatching](coroutines-run-catching.md) | [common]
inline fun <[T](coroutines-run-catching.md), [R](coroutines-run-catching.md)> [T](coroutines-run-catching.md).[coroutinesRunCatching](coroutines-run-catching.md)(block: [T](coroutines-run-catching.md).() -> [R](coroutines-run-catching.md)): [Result](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-result/index.html)<[R](coroutines-run-catching.md)>
Calls the specified function [block](coroutines-run-catching.md) with `this` value as its receiver and returns its encapsulated result if invocation was successful, catching any [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) exception besides CancellationException that was thrown from the [block](coroutines-run-catching.md) function execution and encapsulating it as a failure. | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/index.md index 5ff4c4fa..d392b02b 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/index.md @@ -9,4 +9,4 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [withSyncDelegate](with-sync-delegate.md) | [common]
fun <[D](with-sync-delegate.md) : Any, [P](with-sync-delegate.md) : Any> [withSyncDelegate](with-sync-delegate.md)(delegate: [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)>): [SyncDelegateCacheService](../../-sync-delegate-cache-service/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)>
Creates synchronous [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md) cache service | +| [withSyncDelegate](with-sync-delegate.md) | [common]
fun <[D](with-sync-delegate.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-sync-delegate.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [withSyncDelegate](with-sync-delegate.md)(delegate: [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)>): [SyncDelegateCacheService](../../-sync-delegate-cache-service/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)>
Creates synchronous [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md) cache service | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/with-sync-delegate.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/with-sync-delegate.md index 3d400cf1..2f4f85a1 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/with-sync-delegate.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/-companion/with-sync-delegate.md @@ -3,7 +3,7 @@ # withSyncDelegate [common]\ -fun <[D](with-sync-delegate.md) : Any, [P](with-sync-delegate.md) : Any> [withSyncDelegate](with-sync-delegate.md)(delegate: [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)>): [SyncDelegateCacheService](../../-sync-delegate-cache-service/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)> +fun <[D](with-sync-delegate.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](with-sync-delegate.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [withSyncDelegate](with-sync-delegate.md)(delegate: [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)>): [SyncDelegateCacheService](../../-sync-delegate-cache-service/index.md)<[D](with-sync-delegate.md), [P](with-sync-delegate.md)> Creates synchronous [CacheDelegate](../../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md) cache service diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md index 783fee94..b2242001 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md @@ -2,8 +2,7 @@ # CacheService -[common]\ -interface [CacheService](index.md)<[D](index.md) : Any, in [P](index.md) : Any> +interface [CacheService](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Interface to cache an [com.motorro.rxlcemodel.cache.entity.Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) locally Cache should notify subscribers that data has been updated through [getData](get-data.md) channel @@ -16,6 +15,12 @@ common | D | Data type | | P | Params that identify data type | +#### Inheritors + +| | +|---| +| [SyncDelegateCacheService](../-sync-delegate-cache-service/index.md) | + ## Types | Name | Summary | @@ -33,9 +38,3 @@ common | [refetch](refetch.md) | [common]
abstract suspend fun [refetch](refetch.md)(params: [P](index.md))
Makes cache service to refetch cached data updating subscribers with [params](refetch.md) | | [refetchAll](refetch-all.md) | [common]
abstract suspend fun [refetchAll](refetch-all.md)()
Makes cache service to refetch cached data for all active subscribers | | [save](save.md) | [common]
abstract suspend fun [save](save.md)(params: [P](index.md), entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>)
Saves entity in a cache | - -## Inheritors - -| Name | -|---| -| [SyncDelegateCacheService](../-sync-delegate-cache-service/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-net-service/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-net-service/index.md index 2f1b6292..7fd96d3a 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-net-service/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-net-service/index.md @@ -2,8 +2,7 @@ # NetService -[common]\ -interface [NetService](index.md)<[D](index.md) : Any, in [P](index.md) : Any> +interface [NetService](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Interface to load an [com.motorro.rxlcemodel.cache.entity.Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from network @@ -16,14 +15,14 @@ common | D | Data type | | P | Params that identify data type | +#### Inheritors + +| | +|---| +| [UpdatingNetService](../-updating-net-service/index.md) | + ## Functions | Name | Summary | |---|---| | [get](get.md) | [common]
abstract suspend fun [get](get.md)(params: [P](index.md)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>
Gets entity from network or throws on error | - -## Inheritors - -| Name | -|---| -| [UpdatingNetService](../-updating-net-service/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-service-set/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-service-set/index.md index 2b0a0006..56ffeebd 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-service-set/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-service-set/index.md @@ -2,8 +2,7 @@ # ServiceSet -[common]\ -interface [ServiceSet](index.md)<[D](index.md) : Any, in [P](index.md) : Any> +interface [ServiceSet](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Service-set for [com.motorro.rxlcemodel.coroutines.LceModel](../../com.motorro.rxlcemodel.coroutines/-lce-model/index.md) @@ -16,15 +15,15 @@ common | D | Data type | | P | Params that identify data type | +#### Inheritors + +| | +|---| +| [UpdatingServiceSet](../-updating-service-set/index.md) | + ## Properties | Name | Summary | |---|---| | [cache](cache.md) | [common]
abstract val [cache](cache.md): [CacheService](../-cache-service/index.md)<[D](index.md), [P](index.md)>
Cache service | | [net](net.md) | [common]
abstract val [net](net.md): [NetService](../-net-service/index.md)<[D](index.md), [P](index.md)>
Net service | - -## Inheritors - -| Name | -|---| -| [UpdatingServiceSet](../-updating-service-set/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-sync-delegate-cache-service/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-sync-delegate-cache-service/index.md index 17aa9a67..27820452 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-sync-delegate-cache-service/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-sync-delegate-cache-service/index.md @@ -2,8 +2,7 @@ # SyncDelegateCacheService -[common]\ -class [SyncDelegateCacheService](index.md)<[D](index.md) : Any, [P](index.md) : Any> : [CacheService](../-cache-service/index.md)<[D](index.md), [P](index.md)> +class [SyncDelegateCacheService](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)> : [CacheService](../-cache-service/index.md)<[D](index.md), [P](index.md)> Service implementation diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-net-service/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-net-service/index.md index 55c279b8..4048bbf2 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-net-service/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-net-service/index.md @@ -2,8 +2,7 @@ # UpdatingNetService -[common]\ -interface [UpdatingNetService](index.md)<[D](index.md) : Any, in [U](index.md) : Any, in [P](index.md) : Any> : [NetService](../-net-service/index.md)<[D](index.md), [P](index.md)> +interface [UpdatingNetService](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [U](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [NetService](../-net-service/index.md)<[D](index.md), [P](index.md)> [NetService](../-net-service/index.md) extension to update data on server diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md index c8687e3f..8661b9da 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md @@ -2,8 +2,7 @@ # UpdatingServiceSet -[common]\ -interface [UpdatingServiceSet](index.md)<[D](index.md) : Any, in [U](index.md) : Any, in [P](index.md) : Any> : [ServiceSet](../-service-set/index.md)<[D](index.md), [P](index.md)> +interface [UpdatingServiceSet](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [U](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [ServiceSet](../-service-set/index.md)<[D](index.md), [P](index.md)> [ServiceSet](../-service-set/index.md) extension with updating [net](net.md) diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/index.md index 4ef9b12d..b983677a 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines.service/index.md @@ -6,9 +6,9 @@ | Name | Summary | |---|---| -| [CacheService](-cache-service/index.md) | [common]
interface [CacheService](-cache-service/index.md)<[D](-cache-service/index.md) : Any, in [P](-cache-service/index.md) : Any>
Interface to cache an [com.motorro.rxlcemodel.cache.entity.Entity](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) locally Cache should notify subscribers that data has been updated through [getData](-cache-service/get-data.md) channel | -| [NetService](-net-service/index.md) | [common]
interface [NetService](-net-service/index.md)<[D](-net-service/index.md) : Any, in [P](-net-service/index.md) : Any>
Interface to load an [com.motorro.rxlcemodel.cache.entity.Entity](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from network | -| [ServiceSet](-service-set/index.md) | [common]
interface [ServiceSet](-service-set/index.md)<[D](-service-set/index.md) : Any, in [P](-service-set/index.md) : Any>
Service-set for [com.motorro.rxlcemodel.coroutines.LceModel](../com.motorro.rxlcemodel.coroutines/-lce-model/index.md) | -| [SyncDelegateCacheService](-sync-delegate-cache-service/index.md) | [common]
class [SyncDelegateCacheService](-sync-delegate-cache-service/index.md)<[D](-sync-delegate-cache-service/index.md) : Any, [P](-sync-delegate-cache-service/index.md) : Any> : [CacheService](-cache-service/index.md)<[D](-sync-delegate-cache-service/index.md), [P](-sync-delegate-cache-service/index.md)>
Service implementation | -| [UpdatingNetService](-updating-net-service/index.md) | [common]
interface [UpdatingNetService](-updating-net-service/index.md)<[D](-updating-net-service/index.md) : Any, in [U](-updating-net-service/index.md) : Any, in [P](-updating-net-service/index.md) : Any> : [NetService](-net-service/index.md)<[D](-updating-net-service/index.md), [P](-updating-net-service/index.md)>
[NetService](-net-service/index.md) extension to update data on server | -| [UpdatingServiceSet](-updating-service-set/index.md) | [common]
interface [UpdatingServiceSet](-updating-service-set/index.md)<[D](-updating-service-set/index.md) : Any, in [U](-updating-service-set/index.md) : Any, in [P](-updating-service-set/index.md) : Any> : [ServiceSet](-service-set/index.md)<[D](-updating-service-set/index.md), [P](-updating-service-set/index.md)>
[ServiceSet](-service-set/index.md) extension with updating [net](-updating-service-set/net.md) | +| [CacheService](-cache-service/index.md) | [common]
interface [CacheService](-cache-service/index.md)<[D](-cache-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](-cache-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Interface to cache an [com.motorro.rxlcemodel.cache.entity.Entity](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) locally Cache should notify subscribers that data has been updated through [getData](-cache-service/get-data.md) channel | +| [NetService](-net-service/index.md) | [common]
interface [NetService](-net-service/index.md)<[D](-net-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](-net-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Interface to load an [com.motorro.rxlcemodel.cache.entity.Entity](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from network | +| [ServiceSet](-service-set/index.md) | [common]
interface [ServiceSet](-service-set/index.md)<[D](-service-set/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](-service-set/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Service-set for [com.motorro.rxlcemodel.coroutines.LceModel](../com.motorro.rxlcemodel.coroutines/-lce-model/index.md) | +| [SyncDelegateCacheService](-sync-delegate-cache-service/index.md) | [common]
class [SyncDelegateCacheService](-sync-delegate-cache-service/index.md)<[D](-sync-delegate-cache-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](-sync-delegate-cache-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [CacheService](-cache-service/index.md)<[D](-sync-delegate-cache-service/index.md), [P](-sync-delegate-cache-service/index.md)>
Service implementation | +| [UpdatingNetService](-updating-net-service/index.md) | [common]
interface [UpdatingNetService](-updating-net-service/index.md)<[D](-updating-net-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [U](-updating-net-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](-updating-net-service/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [NetService](-net-service/index.md)<[D](-updating-net-service/index.md), [P](-updating-net-service/index.md)>
[NetService](-net-service/index.md) extension to update data on server | +| [UpdatingServiceSet](-updating-service-set/index.md) | [common]
interface [UpdatingServiceSet](-updating-service-set/index.md)<[D](-updating-service-set/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [U](-updating-service-set/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](-updating-service-set/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [ServiceSet](-service-set/index.md)<[D](-updating-service-set/index.md), [P](-updating-service-set/index.md)>
[ServiceSet](-service-set/index.md) extension with updating [net](-updating-service-set/net.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/-cache-then-net-lce-model.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/-cache-then-net-lce-model.md index 81e5ebc7..41cc1c35 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/-cache-then-net-lce-model.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/-cache-then-net-lce-model.md @@ -3,7 +3,7 @@ # CacheThenNetLceModel [common]\ -fun <[DATA](index.md) : Any, [PARAMS](index.md) : Any> [CacheThenNetLceModel](-cache-then-net-lce-model.md)(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/index.md index 2edf5c3e..57349227 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-cache-then-net-lce-model/index.md @@ -2,8 +2,7 @@ # CacheThenNetLceModel -[common]\ -class [CacheThenNetLceModel](index.md)<[DATA](index.md) : Any, [PARAMS](index.md) : Any>(val params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> +class [CacheThenNetLceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> A [LceModel](../-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns null. The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! @@ -25,13 +24,7 @@ common | | | |---|---| -| [CacheThenNetLceModel](-cache-then-net-lce-model.md) | [common]
fun <[DATA](index.md) : Any, [PARAMS](index.md) : Any> [CacheThenNetLceModel](-cache-then-net-lce-model.md)(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | - -## Functions - -| Name | Summary | -|---|---| -| [refresh](refresh.md) | [common]
open suspend override fun [refresh](refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [CacheThenNetLceModel](-cache-then-net-lce-model.md) | [common]
constructor(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -40,11 +33,12 @@ common | [params](params.md) | [common]
open override val [params](params.md): [PARAMS](index.md) | | [state](state.md) | [common]
open override val [state](state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any, [PARAMS](../map.md) : Any> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : Any, [UPDATE](../with-updates.md) : Any, [PARAMS](../with-updates.md) : Any> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | +| [map](../map.md) | [common]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](refresh.md) | [common]
open suspend override fun [refresh](refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/cache-then-net.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/cache-then-net.md index 34349f0c..784d62f5 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/cache-then-net.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/cache-then-net.md @@ -4,9 +4,9 @@ [common]\ -@JvmOverloads +@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html) -fun <[DATA](cache-then-net.md) : Any, [PARAMS](cache-then-net.md) : Any> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), serviceSet: [ServiceSet](../../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)> +fun <[DATA](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), serviceSet: [ServiceSet](../../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)> Creates a model that returns cached data first, then refreshes if stall @@ -26,9 +26,9 @@ common [common]\ -@JvmOverloads +@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html) -fun <[DATA](cache-then-net.md) : Any, [PARAMS](cache-then-net.md) : Any> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), net: [NetService](../../../com.motorro.rxlcemodel.coroutines.service/-net-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, cache: [CacheService](../../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)> +fun <[DATA](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), net: [NetService](../../../com.motorro.rxlcemodel.coroutines.service/-net-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, cache: [CacheService](../../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)> Creates a model that returns cached data first, than refreshes if stall diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/index.md index 407e0e4c..b477d41e 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/-companion/index.md @@ -9,4 +9,4 @@ object [Companion](index.md) | Name | Summary | |---|---| -| [cacheThenNet](cache-then-net.md) | [common]
@JvmOverloads
fun <[DATA](cache-then-net.md) : Any, [PARAMS](cache-then-net.md) : Any> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), serviceSet: [ServiceSet](../../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>
Creates a model that returns cached data first, then refreshes if stall
[common]
@JvmOverloads
fun <[DATA](cache-then-net.md) : Any, [PARAMS](cache-then-net.md) : Any> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), net: [NetService](../../../com.motorro.rxlcemodel.coroutines.service/-net-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, cache: [CacheService](../../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>
Creates a model that returns cached data first, than refreshes if stall | +| [cacheThenNet](cache-then-net.md) | [common]
@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)
fun <[DATA](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), serviceSet: [ServiceSet](../../../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>
Creates a model that returns cached data first, then refreshes if stall
[common]
@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)
fun <[DATA](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](cache-then-net.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [cacheThenNet](cache-then-net.md)(params: [PARAMS](cache-then-net.md), net: [NetService](../../../com.motorro.rxlcemodel.coroutines.service/-net-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, cache: [CacheService](../../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>, startWith: Flow<[LceState](../../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](cache-then-net.md)>> = emptyFlow(), ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [LceModel](../index.md)<[DATA](cache-then-net.md), [PARAMS](cache-then-net.md)>
Creates a model that returns cached data first, than refreshes if stall | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/index.md index 37f76db6..a4f4a973 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/index.md @@ -2,8 +2,7 @@ # LceModel -[common]\ -interface [LceModel](index.md)<[DATA](index.md) : Any, [PARAMS](index.md) : Any> : [LceUseCase](../-lce-use-case/index.md)<[DATA](index.md)> +interface [LceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceUseCase](../-lce-use-case/index.md)<[DATA](index.md)> A model interface to load data and transmit it to subscribers along with loading operation state @@ -16,17 +15,19 @@ common | DATA | Data type of data being loaded | | PARAMS | Params type that identify data being loaded | -## Types +#### Inheritors -| Name | Summary | -|---|---| -| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | +| | +|---| +| [CacheThenNetLceModel](../-cache-then-net-lce-model/index.md) | +| [UpdatingLceModel](../-updating-lce-model/index.md) | +| [UpdateWrapper](../-update-wrapper/index.md) | -## Functions +## Types | Name | Summary | |---|---| -| [refresh](../-lce-use-case/refresh.md) | [common]
abstract suspend fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | ## Properties @@ -35,19 +36,12 @@ common | [params](params.md) | [common]
abstract val [params](params.md): [PARAMS](index.md)
Params that identify data being loaded | | [state](../-lce-use-case/state.md) | [common]
abstract val [state](../-lce-use-case/state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Inheritors - -| Name | -|---| -| [CacheThenNetLceModel](../-cache-then-net-lce-model/index.md) | -| [UpdatingLceModel](../-updating-lce-model/index.md) | -| [UpdateWrapper](../-update-wrapper/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any, [PARAMS](../map.md) : Any> [LceModel](index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : Any, [UPDATE](../with-updates.md) : Any, [PARAMS](../with-updates.md) : Any> [LceModel](index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | +| [map](../map.md) | [common]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](../-lce-use-case/refresh.md) | [common]
abstract suspend fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-use-case/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-use-case/index.md index d382ac8a..01b7c9ec 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-use-case/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-lce-use-case/index.md @@ -2,8 +2,7 @@ # LceUseCase -[common]\ -interface [LceUseCase](index.md)<[DATA](index.md) : Any> +interface [LceUseCase](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Base LCE use-case with [state](state.md) and [refresh](refresh.md) @@ -15,11 +14,11 @@ common |---|---| | DATA | Data type of data being loaded | -## Functions +#### Inheritors -| Name | Summary | -|---|---| -| [refresh](refresh.md) | [common]
abstract suspend fun [refresh](refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| | +|---| +| [LceModel](../-lce-model/index.md) | ## Properties @@ -27,16 +26,11 @@ common |---|---| | [state](state.md) | [common]
abstract val [state](state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Inheritors - -| Name | -|---| -| [LceModel](../-lce-model/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [map](../map.md) | [common]
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)> [LceUseCase](index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](refresh.md) | [common]
abstract suspend fun [refresh](refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/-strategy-update-wrapper.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/-strategy-update-wrapper.md index a82fef74..02f0fbc7 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/-strategy-update-wrapper.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/-strategy-update-wrapper.md @@ -3,7 +3,7 @@ # StrategyUpdateWrapper [common]\ -fun <[DATA](index.md) : Any, [PARAMS](index.md) : Any> [StrategyUpdateWrapper](-strategy-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/index.md index 990536ef..0f535304 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/index.md @@ -2,8 +2,7 @@ # StrategyUpdateWrapper -[common]\ -class [StrategyUpdateWrapper](index.md)<[DATA](index.md) : Any, [PARAMS](index.md) : Any>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](../-update-wrapper/index.md)<[DATA](index.md), [PARAMS](index.md)> +class [StrategyUpdateWrapper](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](../-update-wrapper/index.md)<[DATA](index.md), [PARAMS](index.md)> Wraps [LceModel](../-lce-model/index.md) and mixes in a data update state Use to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/do-update.md) template @@ -24,14 +23,7 @@ common | | | |---|---| -| [StrategyUpdateWrapper](-strategy-update-wrapper.md) | [common]
fun <[DATA](index.md) : Any, [PARAMS](index.md) : Any> [StrategyUpdateWrapper](-strategy-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | - -## Functions - -| Name | Summary | -|---|---| -| [refresh](../-lce-use-case/refresh.md) | [common]
open suspend override fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | -| [update](update.md) | [common]
suspend fun [update](update.md)(dataSource: suspend (params: [PARAMS](index.md)) -> [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DATA](index.md)>)
Creates a cache-update operation that gets data from [dataSource](update.md) and saves to cache. The completable updates [networkOperationState](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/network-operation-state.md) to mix state to original [upstream](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/upstream.md) | +| [StrategyUpdateWrapper](-strategy-update-wrapper.md) | [common]
constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -40,11 +32,13 @@ common | [params](../-lce-model/params.md) | [common]
open override val [params](../-lce-model/params.md): [PARAMS](index.md)
Params that identify data being loaded | | [state](../-update-wrapper/state.md) | [common]
open override val [state](../-update-wrapper/state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/upstream.md) emissions with update operation status. | -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any, [PARAMS](../map.md) : Any> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : Any, [UPDATE](../with-updates.md) : Any, [PARAMS](../with-updates.md) : Any> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | +| [map](../map.md) | [common]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](../-lce-use-case/refresh.md) | [common]
open suspend override fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [update](update.md) | [common]
suspend fun [update](update.md)(dataSource: suspend (params: [PARAMS](index.md)) -> [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DATA](index.md)>)
Creates a cache-update operation that gets data from [dataSource](update.md) and saves to cache. The completable updates [networkOperationState](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/network-operation-state.md) to mix state to original [upstream](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/upstream.md) | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/-update-wrapper.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/-update-wrapper.md index ebe67ca4..683fbce8 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/-update-wrapper.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/-update-wrapper.md @@ -3,7 +3,7 @@ # UpdateWrapper [common]\ -fun <[DATA](index.md) : Any, [PARAMS](index.md) : Any> [UpdateWrapper](-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/index.md index 81c2c3fc..fbad517b 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/index.md @@ -2,8 +2,7 @@ # UpdateWrapper -[common]\ -abstract class [UpdateWrapper](index.md)<[DATA](index.md) : Any, [PARAMS](index.md) : Any>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> +abstract class [UpdateWrapper](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> A base class that wraps [LceModel](../-lce-model/index.md) and mixes in a data update state Extend to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/do-update.md) template @@ -20,17 +19,18 @@ common | ioDispatcher | Scheduler to run IO operations | | logger | Logging function | -## Constructors +#### Inheritors -| | | -|---|---| -| [UpdateWrapper](-update-wrapper.md) | [common]
fun <[DATA](index.md) : Any, [PARAMS](index.md) : Any> [UpdateWrapper](-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | +| | +|---| +| [StrategyUpdateWrapper](../-strategy-update-wrapper/index.md) | +| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | -## Functions +## Constructors -| Name | Summary | +| | | |---|---| -| [refresh](../-lce-use-case/refresh.md) | [common]
open suspend override fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [UpdateWrapper](-update-wrapper.md) | [common]
constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -39,18 +39,12 @@ common | [params](../-lce-model/params.md) | [common]
open override val [params](../-lce-model/params.md): [PARAMS](index.md)
Params that identify data being loaded | | [state](state.md) | [common]
open override val [state](state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/upstream.md) emissions with update operation status. | -## Inheritors - -| Name | -|---| -| [StrategyUpdateWrapper](../-strategy-update-wrapper/index.md) | -| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any, [PARAMS](../map.md) : Any> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : Any, [UPDATE](../with-updates.md) : Any, [PARAMS](../with-updates.md) : Any> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | +| [map](../map.md) | [common]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](../-lce-use-case/refresh.md) | [common]
open suspend override fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md index 7c5e1b48..90873315 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md @@ -3,7 +3,7 @@ # UpdatingLceModelWrapper [common]\ -fun <[DATA](index.md) : Any, in [UPDATE](index.md) : Any, [PARAMS](index.md) : Any> [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/index.md index b25478c3..7dcb97cf 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model-wrapper/index.md @@ -2,19 +2,10 @@ # UpdatingLceModelWrapper -[common]\ -class [UpdatingLceModelWrapper](index.md)<[DATA](index.md) : Any, in [UPDATE](index.md) : Any, [PARAMS](index.md) : Any>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](../-update-wrapper/index.md)<[DATA](index.md), [PARAMS](index.md)> , [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)> +class [UpdatingLceModelWrapper](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](../-update-wrapper/index.md)<[DATA](index.md), [PARAMS](index.md)> , [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)> Wraps an [LceModel](../-lce-model/index.md) to enable simple data updates with the [UPDATE](index.md) structure (say a PUT operation) rather than individual property updates (PATCH operation). Implement [UpdateWrapper](../-update-wrapper/index.md) to achieve PATCH workflow -#### See also - -common - -| | -|---| -| [UpdateWrapper](../-update-wrapper/index.md) | - #### Parameters common @@ -29,18 +20,17 @@ common | ioDispatcher | Scheduler to run IO operations | | logger | Logging function | -## Constructors +#### See also -| | | -|---|---| -| [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md) | [common]
fun <[DATA](index.md) : Any, in [UPDATE](index.md) : Any, [PARAMS](index.md) : Any> [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | +| | +|---| +| [UpdateWrapper](../-update-wrapper/index.md) | -## Functions +## Constructors -| Name | Summary | +| | | |---|---| -| [refresh](../-lce-use-case/refresh.md) | [common]
open suspend override fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | -| [update](update.md) | [common]
open suspend override fun [update](update.md)(update: [UPDATE](index.md))
Updates data on server and refreshes local data | +| [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md) | [common]
constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -49,11 +39,13 @@ common | [params](../-lce-model/params.md) | [common]
open override val [params](../-lce-model/params.md): [PARAMS](index.md)
Params that identify data being loaded | | [state](../-update-wrapper/state.md) | [common]
open override val [state](../-update-wrapper/state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/upstream.md) emissions with update operation status. | -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any, [PARAMS](../map.md) : Any> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : Any, [UPDATE](../with-updates.md) : Any, [PARAMS](../with-updates.md) : Any> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | +| [map](../map.md) | [common]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](../-lce-use-case/refresh.md) | [common]
open suspend override fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [update](update.md) | [common]
open suspend override fun [update](update.md)(update: [UPDATE](index.md))
Updates data on server and refreshes local data | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model/index.md index c1992853..8e055b95 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/-updating-lce-model/index.md @@ -2,8 +2,7 @@ # UpdatingLceModel -[common]\ -interface [UpdatingLceModel](index.md)<[DATA](index.md) : Any, in [UPDATE](index.md) : Any, [PARAMS](index.md) : Any> : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> +interface [UpdatingLceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> [LceModel](../-lce-model/index.md) extension that can [update](update.md) data @@ -17,12 +16,11 @@ common | UPDATE | Update type | | PARAMS | Params type that identify data being loaded | -## Functions +#### Inheritors -| Name | Summary | -|---|---| -| [refresh](../-lce-use-case/refresh.md) | [common]
abstract suspend fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | -| [update](update.md) | [common]
abstract suspend fun [update](update.md)(update: [UPDATE](index.md))
Updates data on server and refreshes local data | +| | +|---| +| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | ## Properties @@ -31,17 +29,13 @@ common | [params](../-lce-model/params.md) | [common]
abstract val [params](../-lce-model/params.md): [PARAMS](index.md)
Params that identify data being loaded | | [state](../-lce-use-case/state.md) | [common]
abstract val [state](../-lce-use-case/state.md): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Inheritors - -| Name | -|---| -| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| -| [map](../map.md) | [common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any, [PARAMS](../map.md) : Any> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
fun <[DATA_1](../map.md) : Any, [DATA_2](../map.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | -| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | -| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : Any> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : Any, [UPDATE](../with-updates.md) : Any, [PARAMS](../with-updates.md) : Any> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](index.md) | +| [map](../map.md) | [common]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[common]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | +| [refresh](../-lce-use-case/refresh.md) | [common]
abstract suspend fun [refresh](../-lce-use-case/refresh.md)()
Requests a refresh of data. Data will be updated asynchronously | +| [refreshed](../refreshed.md) | [common]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [update](update.md) | [common]
abstract suspend fun [update](update.md)(update: [UPDATE](index.md))
Updates data on server and refreshes local data | +| [withRefresh](../with-refresh.md) | [common]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](../with-updates.md) | [common]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-no-errors.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-no-errors.md index 312791f2..3979736e 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-no-errors.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-no-errors.md @@ -3,7 +3,7 @@ # dataNoErrors [common]\ -val <[DATA](data-no-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-no-errors.md)>>.[dataNoErrors](data-no-errors.md): Flow<[DATA](data-no-errors.md)> +val <[DATA](data-no-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-no-errors.md)>>.[dataNoErrors](data-no-errors.md): Flow<[DATA](data-no-errors.md)> Model's data stream with state information dropped. No error state terminates stream diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-empty-errors.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-empty-errors.md index 9a7036e7..17f7c670 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-empty-errors.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-empty-errors.md @@ -3,7 +3,7 @@ # dataStopOnEmptyErrors [common]\ -val <[DATA](data-stop-on-empty-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-empty-errors.md)>>.[dataStopOnEmptyErrors](data-stop-on-empty-errors.md): Flow<[DATA](data-stop-on-empty-errors.md)> +val <[DATA](data-stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-empty-errors.md)>>.[dataStopOnEmptyErrors](data-stop-on-empty-errors.md): Flow<[DATA](data-stop-on-empty-errors.md)> Model's data stream with state information dropped. Will terminate on errors with empty data diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-errors.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-errors.md index 3523e701..17f01ead 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-errors.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-errors.md @@ -3,7 +3,7 @@ # dataStopOnErrors [common]\ -val <[DATA](data-stop-on-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-errors.md)>>.[dataStopOnErrors](data-stop-on-errors.md): Flow<[DATA](data-stop-on-errors.md)> +val <[DATA](data-stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-errors.md)>>.[dataStopOnErrors](data-stop-on-errors.md): Flow<[DATA](data-stop-on-errors.md)> Model's data stream with state information dropped. Will terminate on any error diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/error-to-lce.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/error-to-lce.md index 99764c6a..fff65554 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/error-to-lce.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/error-to-lce.md @@ -3,7 +3,7 @@ # errorToLce [common]\ -inline fun <[T](error-to-lce.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>.[errorToLce](error-to-lce.md)(crossinline errorData: (Throwable) -> [T](error-to-lce.md)? = { null }): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>> +inline fun <[T](error-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>.[errorToLce](error-to-lce.md)(crossinline errorData: ([Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [T](error-to-lce.md)? = { null }): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>> Maps an upstream error to LceError diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-latest-flow.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-latest-flow.md new file mode 100644 index 00000000..92765714 --- /dev/null +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-latest-flow.md @@ -0,0 +1,18 @@ +//[coroutines](../../index.md)/[com.motorro.rxlcemodel.coroutines](index.md)/[flatMapLatestFlow](flat-map-latest-flow.md) + +# flatMapLatestFlow + +[common]\ +fun <[DATA_1](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-latest-flow.md)>>.[flatMapLatestFlow](flat-map-latest-flow.md)(mapper: suspend (data: [DATA_1](flat-map-latest-flow.md)) -> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>> + +Maps each [DATA_1](flat-map-latest-flow.md) to flow for [DATA_2](flat-map-latest-flow.md) and combines with original state. If error occurs in [mapper](flat-map-latest-flow.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: Using original [DATA_1](flat-map-latest-flow.md) as a parameter switch to new [DATA_2](flat-map-latest-flow.md) LCE flow + +#### Parameters + +common + +| | | +|---|---| +| DATA_1 | Source data type | +| DATA_2 | Resulting data type | +| mapper | Data mapper | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-single-data.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-single-data.md index 969cf27c..fd32f307 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-single-data.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-single-data.md @@ -3,7 +3,7 @@ # flatMapSingleData [common]\ -fun <[DATA_1](flat-map-single-data.md) : Any, [DATA_2](flat-map-single-data.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-single-data.md)>>.[flatMapSingleData](flat-map-single-data.md)(mapper: suspend (data: [DATA_1](flat-map-single-data.md)) -> [DATA_2](flat-map-single-data.md)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-single-data.md)>> +fun <[DATA_1](flat-map-single-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-single-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-single-data.md)>>.[flatMapSingleData](flat-map-single-data.md)(mapper: suspend (data: [DATA_1](flat-map-single-data.md)) -> [DATA_2](flat-map-single-data.md)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-single-data.md)>> Maps each [DATA_1](flat-map-single-data.md) to single for [DATA_2](flat-map-single-data.md) and merges back to LceState. If error occurs in [mapper](flat-map-single-data.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: load some [DATA_2](flat-map-single-data.md) from server using original [DATA_1](flat-map-single-data.md) as a parameter. diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/get-data.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/get-data.md index 90f1bae8..2de15d1d 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/get-data.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/get-data.md @@ -3,7 +3,7 @@ # getData [common]\ -fun <[DATA](get-data.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](get-data.md)>>.[getData](get-data.md)(terminateOnError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](get-data.md)>) -> Boolean): Flow<[DATA](get-data.md)> +fun <[DATA](get-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](get-data.md)>>.[getData](get-data.md)(terminateOnError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](get-data.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): Flow<[DATA](get-data.md)> Returns model's data stream dropping state information diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/index.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/index.md index 24c63fbd..cd3d0ff1 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/index.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/index.md @@ -6,36 +6,37 @@ | Name | Summary | |---|---| -| [CacheThenNetLceModel](-cache-then-net-lce-model/index.md) | [common]
class [CacheThenNetLceModel](-cache-then-net-lce-model/index.md)<[DATA](-cache-then-net-lce-model/index.md) : Any, [PARAMS](-cache-then-net-lce-model/index.md) : Any>(val params: [PARAMS](-cache-then-net-lce-model/index.md), serviceSet: [ServiceSet](../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](-cache-then-net-lce-model/index.md), [PARAMS](-cache-then-net-lce-model/index.md)>, startWith: Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](-cache-then-net-lce-model/index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](-lce-model/index.md)<[DATA](-cache-then-net-lce-model/index.md), [PARAMS](-cache-then-net-lce-model/index.md)>
A [LceModel](-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](-cache-then-net-lce-model/state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns null. The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! | -| [LceModel](-lce-model/index.md) | [common]
interface [LceModel](-lce-model/index.md)<[DATA](-lce-model/index.md) : Any, [PARAMS](-lce-model/index.md) : Any> : [LceUseCase](-lce-use-case/index.md)<[DATA](-lce-model/index.md)>
A model interface to load data and transmit it to subscribers along with loading operation state | -| [LceUseCase](-lce-use-case/index.md) | [common]
interface [LceUseCase](-lce-use-case/index.md)<[DATA](-lce-use-case/index.md) : Any>
Base LCE use-case with [state](-lce-use-case/state.md) and [refresh](-lce-use-case/refresh.md) | -| [StrategyUpdateWrapper](-strategy-update-wrapper/index.md) | [common]
class [StrategyUpdateWrapper](-strategy-update-wrapper/index.md)<[DATA](-strategy-update-wrapper/index.md) : Any, [PARAMS](-strategy-update-wrapper/index.md) : Any>(upstream: [LceModel](-lce-model/index.md)<[DATA](-strategy-update-wrapper/index.md), [PARAMS](-strategy-update-wrapper/index.md)>, cacheService: [CacheService](../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](-strategy-update-wrapper/index.md), [PARAMS](-strategy-update-wrapper/index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](-update-wrapper/index.md)<[DATA](-strategy-update-wrapper/index.md), [PARAMS](-strategy-update-wrapper/index.md)>
Wraps [LceModel](-lce-model/index.md) and mixes in a data update state Use to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/do-update.md) template | -| [UpdateWrapper](-update-wrapper/index.md) | [common]
abstract class [UpdateWrapper](-update-wrapper/index.md)<[DATA](-update-wrapper/index.md) : Any, [PARAMS](-update-wrapper/index.md) : Any>(upstream: [LceModel](-lce-model/index.md)<[DATA](-update-wrapper/index.md), [PARAMS](-update-wrapper/index.md)>, cacheService: [CacheService](../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](-update-wrapper/index.md), [PARAMS](-update-wrapper/index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](-lce-model/index.md)<[DATA](-update-wrapper/index.md), [PARAMS](-update-wrapper/index.md)>
A base class that wraps [LceModel](-lce-model/index.md) and mixes in a data update state Extend to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/do-update.md) template | -| [UpdatingLceModel](-updating-lce-model/index.md) | [common]
interface [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](-updating-lce-model/index.md) : Any, in [UPDATE](-updating-lce-model/index.md) : Any, [PARAMS](-updating-lce-model/index.md) : Any> : [LceModel](-lce-model/index.md)<[DATA](-updating-lce-model/index.md), [PARAMS](-updating-lce-model/index.md)>
[LceModel](-lce-model/index.md) extension that can [update](-updating-lce-model/update.md) data | -| [UpdatingLceModelWrapper](-updating-lce-model-wrapper/index.md) | [common]
class [UpdatingLceModelWrapper](-updating-lce-model-wrapper/index.md)<[DATA](-updating-lce-model-wrapper/index.md) : Any, in [UPDATE](-updating-lce-model-wrapper/index.md) : Any, [PARAMS](-updating-lce-model-wrapper/index.md) : Any>(upstream: [LceModel](-lce-model/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>, serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [UPDATE](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](-update-wrapper/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)> , [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [UPDATE](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>
Wraps an [LceModel](-lce-model/index.md) to enable simple data updates with the [UPDATE](-updating-lce-model-wrapper/index.md) structure (say a PUT operation) rather than individual property updates (PATCH operation). Implement [UpdateWrapper](-update-wrapper/index.md) to achieve PATCH workflow | +| [CacheThenNetLceModel](-cache-then-net-lce-model/index.md) | [common]
class [CacheThenNetLceModel](-cache-then-net-lce-model/index.md)<[DATA](-cache-then-net-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-cache-then-net-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val params: [PARAMS](-cache-then-net-lce-model/index.md), serviceSet: [ServiceSet](../com.motorro.rxlcemodel.coroutines.service/-service-set/index.md)<[DATA](-cache-then-net-lce-model/index.md), [PARAMS](-cache-then-net-lce-model/index.md)>, startWith: Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](-cache-then-net-lce-model/index.md)>>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](-lce-model/index.md)<[DATA](-cache-then-net-lce-model/index.md), [PARAMS](-cache-then-net-lce-model/index.md)>
A [LceModel](-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](-cache-then-net-lce-model/state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns null. The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! | +| [LceModel](-lce-model/index.md) | [common]
interface [LceModel](-lce-model/index.md)<[DATA](-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceUseCase](-lce-use-case/index.md)<[DATA](-lce-model/index.md)>
A model interface to load data and transmit it to subscribers along with loading operation state | +| [LceUseCase](-lce-use-case/index.md) | [common]
interface [LceUseCase](-lce-use-case/index.md)<[DATA](-lce-use-case/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Base LCE use-case with [state](-lce-use-case/state.md) and [refresh](-lce-use-case/refresh.md) | +| [StrategyUpdateWrapper](-strategy-update-wrapper/index.md) | [common]
class [StrategyUpdateWrapper](-strategy-update-wrapper/index.md)<[DATA](-strategy-update-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-strategy-update-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](-lce-model/index.md)<[DATA](-strategy-update-wrapper/index.md), [PARAMS](-strategy-update-wrapper/index.md)>, cacheService: [CacheService](../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](-strategy-update-wrapper/index.md), [PARAMS](-strategy-update-wrapper/index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](-update-wrapper/index.md)<[DATA](-strategy-update-wrapper/index.md), [PARAMS](-strategy-update-wrapper/index.md)>
Wraps [LceModel](-lce-model/index.md) and mixes in a data update state Use to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../coroutines/com.motorro.rxlcemodel.coroutines/-strategy-update-wrapper/do-update.md) template | +| [UpdateWrapper](-update-wrapper/index.md) | [common]
abstract class [UpdateWrapper](-update-wrapper/index.md)<[DATA](-update-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-update-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](-lce-model/index.md)<[DATA](-update-wrapper/index.md), [PARAMS](-update-wrapper/index.md)>, cacheService: [CacheService](../com.motorro.rxlcemodel.coroutines.service/-cache-service/index.md)<[DATA](-update-wrapper/index.md), [PARAMS](-update-wrapper/index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](-lce-model/index.md)<[DATA](-update-wrapper/index.md), [PARAMS](-update-wrapper/index.md)>
A base class that wraps [LceModel](-lce-model/index.md) and mixes in a data update state Extend to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../coroutines/com.motorro.rxlcemodel.coroutines/-update-wrapper/do-update.md) template | +| [UpdatingLceModel](-updating-lce-model/index.md) | [common]
interface [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](-updating-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](-updating-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-updating-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceModel](-lce-model/index.md)<[DATA](-updating-lce-model/index.md), [PARAMS](-updating-lce-model/index.md)>
[LceModel](-lce-model/index.md) extension that can [update](-updating-lce-model/update.md) data | +| [UpdatingLceModelWrapper](-updating-lce-model-wrapper/index.md) | [common]
class [UpdatingLceModelWrapper](-updating-lce-model-wrapper/index.md)<[DATA](-updating-lce-model-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](-updating-lce-model-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-updating-lce-model-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](-lce-model/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>, serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [UPDATE](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>, ioDispatcher: CoroutineDispatcher, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](-update-wrapper/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)> , [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [UPDATE](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>
Wraps an [LceModel](-lce-model/index.md) to enable simple data updates with the [UPDATE](-updating-lce-model-wrapper/index.md) structure (say a PUT operation) rather than individual property updates (PATCH operation). Implement [UpdateWrapper](-update-wrapper/index.md) to achieve PATCH workflow | -## Functions +## Properties | Name | Summary | |---|---| -| [errorToLce](error-to-lce.md) | [common]
inline fun <[T](error-to-lce.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>.[errorToLce](error-to-lce.md)(crossinline errorData: (Throwable) -> [T](error-to-lce.md)? = { null }): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>
Maps an upstream error to LceError | -| [flatMapSingleData](flat-map-single-data.md) | [common]
fun <[DATA_1](flat-map-single-data.md) : Any, [DATA_2](flat-map-single-data.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-single-data.md)>>.[flatMapSingleData](flat-map-single-data.md)(mapper: suspend (data: [DATA_1](flat-map-single-data.md)) -> [DATA_2](flat-map-single-data.md)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-single-data.md)>>
Maps each [DATA_1](flat-map-single-data.md) to single for [DATA_2](flat-map-single-data.md) and merges back to LceState. If error occurs in [mapper](flat-map-single-data.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: load some [DATA_2](flat-map-single-data.md) from server using original [DATA_1](flat-map-single-data.md) as a parameter. | -| [getData](get-data.md) | [common]
fun <[DATA](get-data.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](get-data.md)>>.[getData](get-data.md)(terminateOnError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](get-data.md)>) -> Boolean): Flow<[DATA](get-data.md)>
Returns model's data stream dropping state information | -| [map](map.md) | [common]
fun <[DATA_1](map.md) : Any, [DATA_2](map.md) : Any, [PARAMS](map.md) : Any> [LceModel](-lce-model/index.md)<[DATA_1](map.md), [PARAMS](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceModel](-lce-model/index.md)<[DATA_2](map.md), [PARAMS](map.md)>
Creates a model wrapper that converts [DATA_1](map.md) to [DATA_2](map.md)
[common]
fun <[DATA_1](map.md) : Any, [DATA_2](map.md) : Any> [LceUseCase](-lce-use-case/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceUseCase](-lce-use-case/index.md)<[DATA_2](map.md)>
Creates a use-case wrapper that converts [DATA_1](map.md) to [DATA_2](map.md) | -| [onEmptyLoadingReturn](on-empty-loading-return.md) | [common]
inline fun <[DATA](on-empty-loading-return.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>>.[onEmptyLoadingReturn](on-empty-loading-return.md)(crossinline block: ([LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md)<[DATA](on-empty-loading-return.md)>) -> [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>>
Substitutes [LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md) with empty data with state produced by [block](on-empty-loading-return.md) | -| [onEmptyLoadingReturnItem](on-empty-loading-return-item.md) | [common]
inline fun <[DATA](on-empty-loading-return-item.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>>.[onEmptyLoadingReturnItem](on-empty-loading-return-item.md)(crossinline block: () -> [DATA](on-empty-loading-return-item.md)?): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>>
Substitutes [LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md) empty data with data produced by [block](on-empty-loading-return-item.md) | -| [refreshed](refreshed.md) | [common]
fun <[DATA](refreshed.md) : Any> [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)>.[refreshed](refreshed.md)(): [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)>
Wraps use-case to refresh on each subscription
[common]
fun <[DATA](refreshed.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>>.[refreshed](refreshed.md)(refresh: suspend () -> Unit): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>>
Refreshes data on subscription once | -| [terminateOnError](terminate-on-error.md) | [common]
fun <[DATA](terminate-on-error.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>.[terminateOnError](terminate-on-error.md)(predicate: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](terminate-on-error.md)>) -> Boolean): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>
Terminates [LceUseCase.state](-lce-use-case/state.md) stream if [predicate](terminate-on-error.md) returns true | -| [withRefresh](with-refresh.md) | [common]
fun <[DATA](with-refresh.md) : Any> [LceUseCase](-lce-use-case/index.md)<[DATA](with-refresh.md)>.[withRefresh](with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](with-refresh.md)>>
Takes the [LceUseCase.state](-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | -| [withUpdates](with-updates.md) | [common]
fun <[DATA](with-updates.md) : Any, [UPDATE](with-updates.md) : Any, [PARAMS](with-updates.md) : Any> [LceModel](-lce-model/index.md)<[DATA](with-updates.md), [PARAMS](with-updates.md)>.[withUpdates](with-updates.md)(serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>
Wraps an [LceModel](-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](-updating-lce-model/index.md) | +| [dataNoErrors](data-no-errors.md) | [common]
val <[DATA](data-no-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-no-errors.md)>>.[dataNoErrors](data-no-errors.md): Flow<[DATA](data-no-errors.md)>
Model's data stream with state information dropped. No error state terminates stream | +| [dataStopOnEmptyErrors](data-stop-on-empty-errors.md) | [common]
val <[DATA](data-stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-empty-errors.md)>>.[dataStopOnEmptyErrors](data-stop-on-empty-errors.md): Flow<[DATA](data-stop-on-empty-errors.md)>
Model's data stream with state information dropped. Will terminate on errors with empty data | +| [dataStopOnErrors](data-stop-on-errors.md) | [common]
val <[DATA](data-stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-errors.md)>>.[dataStopOnErrors](data-stop-on-errors.md): Flow<[DATA](data-stop-on-errors.md)>
Model's data stream with state information dropped. Will terminate on any error | +| [stopOnEmptyErrors](stop-on-empty-errors.md) | [common]
val <[DATA](stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>.[stopOnEmptyErrors](stop-on-empty-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>
Model's state stream which terminates on errors with empty data | +| [stopOnErrors](stop-on-errors.md) | [common]
val <[DATA](stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>.[stopOnErrors](stop-on-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>
Model's state stream which terminates on any error | +| [validData](valid-data.md) | [common]
val <[DATA](valid-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](valid-data.md)>>.[validData](valid-data.md): Flow<[DATA](valid-data.md)>
Model's valid data stream with state information dropped. Will terminate on any error | -## Properties +## Functions | Name | Summary | |---|---| -| [dataNoErrors](data-no-errors.md) | [common]
val <[DATA](data-no-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-no-errors.md)>>.[dataNoErrors](data-no-errors.md): Flow<[DATA](data-no-errors.md)>
Model's data stream with state information dropped. No error state terminates stream | -| [dataStopOnEmptyErrors](data-stop-on-empty-errors.md) | [common]
val <[DATA](data-stop-on-empty-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-empty-errors.md)>>.[dataStopOnEmptyErrors](data-stop-on-empty-errors.md): Flow<[DATA](data-stop-on-empty-errors.md)>
Model's data stream with state information dropped. Will terminate on errors with empty data | -| [dataStopOnErrors](data-stop-on-errors.md) | [common]
val <[DATA](data-stop-on-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-errors.md)>>.[dataStopOnErrors](data-stop-on-errors.md): Flow<[DATA](data-stop-on-errors.md)>
Model's data stream with state information dropped. Will terminate on any error | -| [stopOnEmptyErrors](stop-on-empty-errors.md) | [common]
val <[DATA](stop-on-empty-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>.[stopOnEmptyErrors](stop-on-empty-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>
Model's state stream which terminates on errors with empty data | -| [stopOnErrors](stop-on-errors.md) | [common]
val <[DATA](stop-on-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>.[stopOnErrors](stop-on-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>
Model's state stream which terminates on any error | -| [validData](valid-data.md) | [common]
val <[DATA](valid-data.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](valid-data.md)>>.[validData](valid-data.md): Flow<[DATA](valid-data.md)>
Model's valid data stream with state information dropped. Will terminate on any error | +| [errorToLce](error-to-lce.md) | [common]
inline fun <[T](error-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>.[errorToLce](error-to-lce.md)(crossinline errorData: ([Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [T](error-to-lce.md)? = { null }): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>
Maps an upstream error to LceError | +| [flatMapLatestFlow](flat-map-latest-flow.md) | [common]
fun <[DATA_1](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-latest-flow.md)>>.[flatMapLatestFlow](flat-map-latest-flow.md)(mapper: suspend (data: [DATA_1](flat-map-latest-flow.md)) -> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>>
Maps each [DATA_1](flat-map-latest-flow.md) to flow for [DATA_2](flat-map-latest-flow.md) and combines with original state. If error occurs in [mapper](flat-map-latest-flow.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: Using original [DATA_1](flat-map-latest-flow.md) as a parameter switch to new [DATA_2](flat-map-latest-flow.md) LCE flow | +| [flatMapSingleData](flat-map-single-data.md) | [common]
fun <[DATA_1](flat-map-single-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-single-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-single-data.md)>>.[flatMapSingleData](flat-map-single-data.md)(mapper: suspend (data: [DATA_1](flat-map-single-data.md)) -> [DATA_2](flat-map-single-data.md)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-single-data.md)>>
Maps each [DATA_1](flat-map-single-data.md) to single for [DATA_2](flat-map-single-data.md) and merges back to LceState. If error occurs in [mapper](flat-map-single-data.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: load some [DATA_2](flat-map-single-data.md) from server using original [DATA_1](flat-map-single-data.md) as a parameter. | +| [getData](get-data.md) | [common]
fun <[DATA](get-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](get-data.md)>>.[getData](get-data.md)(terminateOnError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](get-data.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): Flow<[DATA](get-data.md)>
Returns model's data stream dropping state information | +| [map](map.md) | [common]
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), [PARAMS](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](-lce-model/index.md)<[DATA_1](map.md), [PARAMS](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceModel](-lce-model/index.md)<[DATA_2](map.md), [PARAMS](map.md)>
Creates a model wrapper that converts [DATA_1](map.md) to [DATA_2](map.md)
[common]
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)> [LceUseCase](-lce-use-case/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceUseCase](-lce-use-case/index.md)<[DATA_2](map.md)>
Creates a use-case wrapper that converts [DATA_1](map.md) to [DATA_2](map.md) | +| [onEmptyLoadingReturn](on-empty-loading-return.md) | [common]
inline fun <[DATA](on-empty-loading-return.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>>.[onEmptyLoadingReturn](on-empty-loading-return.md)(crossinline block: ([LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md)<[DATA](on-empty-loading-return.md)>) -> [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>>
Substitutes [LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md) with empty data with state produced by [block](on-empty-loading-return.md) | +| [onEmptyLoadingReturnItem](on-empty-loading-return-item.md) | [common]
inline fun <[DATA](on-empty-loading-return-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>>.[onEmptyLoadingReturnItem](on-empty-loading-return-item.md)(crossinline block: () -> [DATA](on-empty-loading-return-item.md)?): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>>
Substitutes [LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md) empty data with data produced by [block](on-empty-loading-return-item.md) | +| [refreshed](refreshed.md) | [common]
fun <[DATA](refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)>.[refreshed](refreshed.md)(): [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)>
Wraps use-case to refresh on each subscription
[common]
fun <[DATA](refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>>.[refreshed](refreshed.md)(refresh: suspend () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>>
Refreshes data on subscription once | +| [terminateOnError](terminate-on-error.md) | [common]
fun <[DATA](terminate-on-error.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>.[terminateOnError](terminate-on-error.md)(predicate: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](terminate-on-error.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>
Terminates [LceUseCase.state](-lce-use-case/state.md) stream if [predicate](terminate-on-error.md) returns true | +| [withRefresh](with-refresh.md) | [common]
fun <[DATA](with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](-lce-use-case/index.md)<[DATA](with-refresh.md)>.[withRefresh](with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](with-refresh.md)>>
Takes the [LceUseCase.state](-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world | +| [withUpdates](with-updates.md) | [common]
fun <[DATA](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](-lce-model/index.md)<[DATA](with-updates.md), [PARAMS](with-updates.md)>.[withUpdates](with-updates.md)(serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>
Wraps an [LceModel](-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](-updating-lce-model/index.md) | diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/map.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/map.md index 45e492e8..bdf6420f 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/map.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/map.md @@ -3,7 +3,7 @@ # map [common]\ -fun <[DATA_1](map.md) : Any, [DATA_2](map.md) : Any> [LceUseCase](-lce-use-case/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceUseCase](-lce-use-case/index.md)<[DATA_2](map.md)> +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)> [LceUseCase](-lce-use-case/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceUseCase](-lce-use-case/index.md)<[DATA_2](map.md)> Creates a use-case wrapper that converts [DATA_1](map.md) to [DATA_2](map.md) @@ -22,7 +22,7 @@ common | mapper | Data mapper | [common]\ -fun <[DATA_1](map.md) : Any, [DATA_2](map.md) : Any, [PARAMS](map.md) : Any> [LceModel](-lce-model/index.md)<[DATA_1](map.md), [PARAMS](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceModel](-lce-model/index.md)<[DATA_2](map.md), [PARAMS](map.md)> +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), [PARAMS](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](-lce-model/index.md)<[DATA_1](map.md), [PARAMS](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceModel](-lce-model/index.md)<[DATA_2](map.md), [PARAMS](map.md)> Creates a model wrapper that converts [DATA_1](map.md) to [DATA_2](map.md) diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return-item.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return-item.md index 4eb4e6d5..24fab17c 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return-item.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return-item.md @@ -3,7 +3,7 @@ # onEmptyLoadingReturnItem [common]\ -inline fun <[DATA](on-empty-loading-return-item.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>>.[onEmptyLoadingReturnItem](on-empty-loading-return-item.md)(crossinline block: () -> [DATA](on-empty-loading-return-item.md)?): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>> +inline fun <[DATA](on-empty-loading-return-item.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>>.[onEmptyLoadingReturnItem](on-empty-loading-return-item.md)(crossinline block: () -> [DATA](on-empty-loading-return-item.md)?): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return-item.md)>> Substitutes [LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md) empty data with data produced by [block](on-empty-loading-return-item.md) diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return.md index 5ed850a8..e0c8d08a 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/on-empty-loading-return.md @@ -3,7 +3,7 @@ # onEmptyLoadingReturn [common]\ -inline fun <[DATA](on-empty-loading-return.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>>.[onEmptyLoadingReturn](on-empty-loading-return.md)(crossinline block: ([LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md)<[DATA](on-empty-loading-return.md)>) -> [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>> +inline fun <[DATA](on-empty-loading-return.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>>.[onEmptyLoadingReturn](on-empty-loading-return.md)(crossinline block: ([LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md)<[DATA](on-empty-loading-return.md)>) -> [LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](on-empty-loading-return.md)>> Substitutes [LceState.Loading](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md) with empty data with state produced by [block](on-empty-loading-return.md) diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/refreshed.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/refreshed.md index 163755f9..b28e4a86 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/refreshed.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/refreshed.md @@ -3,7 +3,7 @@ # refreshed [common]\ -fun <[DATA](refreshed.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>>.[refreshed](refreshed.md)(refresh: suspend () -> Unit): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>> +fun <[DATA](refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>>.[refreshed](refreshed.md)(refresh: suspend () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](refreshed.md)>> Refreshes data on subscription once @@ -20,7 +20,7 @@ common | refresh | Refresh operation | [common]\ -fun <[DATA](refreshed.md) : Any> [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)>.[refreshed](refreshed.md)(): [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)> +fun <[DATA](refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)>.[refreshed](refreshed.md)(): [LceUseCase](-lce-use-case/index.md)<[DATA](refreshed.md)> Wraps use-case to refresh on each subscription diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-empty-errors.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-empty-errors.md index 584f967e..9e87f698 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-empty-errors.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-empty-errors.md @@ -3,7 +3,7 @@ # stopOnEmptyErrors [common]\ -val <[DATA](stop-on-empty-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>.[stopOnEmptyErrors](stop-on-empty-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>> +val <[DATA](stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>.[stopOnEmptyErrors](stop-on-empty-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>> Model's state stream which terminates on errors with empty data diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-errors.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-errors.md index b830662c..85c7dfdc 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-errors.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/stop-on-errors.md @@ -3,7 +3,7 @@ # stopOnErrors [common]\ -val <[DATA](stop-on-errors.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>.[stopOnErrors](stop-on-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>> +val <[DATA](stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>.[stopOnErrors](stop-on-errors.md): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>> Model's state stream which terminates on any error diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/terminate-on-error.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/terminate-on-error.md index 04922254..bb542276 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/terminate-on-error.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/terminate-on-error.md @@ -3,7 +3,7 @@ # terminateOnError [common]\ -fun <[DATA](terminate-on-error.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>.[terminateOnError](terminate-on-error.md)(predicate: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](terminate-on-error.md)>) -> Boolean): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>> +fun <[DATA](terminate-on-error.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>.[terminateOnError](terminate-on-error.md)(predicate: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](terminate-on-error.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>> Terminates [LceUseCase.state](-lce-use-case/state.md) stream if [predicate](terminate-on-error.md) returns true diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/valid-data.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/valid-data.md index 15c1c051..328e5ebd 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/valid-data.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/valid-data.md @@ -3,7 +3,7 @@ # validData [common]\ -val <[DATA](valid-data.md) : Any> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](valid-data.md)>>.[validData](valid-data.md): Flow<[DATA](valid-data.md)> +val <[DATA](valid-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](valid-data.md)>>.[validData](valid-data.md): Flow<[DATA](valid-data.md)> Model's valid data stream with state information dropped. Will terminate on any error diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-refresh.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-refresh.md index 537b92af..5d0ad305 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-refresh.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-refresh.md @@ -3,7 +3,7 @@ # withRefresh [common]\ -fun <[DATA](with-refresh.md) : Any> [LceUseCase](-lce-use-case/index.md)<[DATA](with-refresh.md)>.[withRefresh](with-refresh.md)(refreshStream: Flow<Any>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](with-refresh.md)>> +fun <[DATA](with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](-lce-use-case/index.md)<[DATA](with-refresh.md)>.[withRefresh](with-refresh.md)(refreshStream: Flow<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>): Flow<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](with-refresh.md)>> Takes the [LceUseCase.state](-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../coroutines/com.motorro.rxlcemodel.coroutines/-lce-model/refresh.md) property becomes invisible for the outside world diff --git a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-updates.md b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-updates.md index b12ebfbd..9712039b 100644 --- a/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-updates.md +++ b/docs/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/with-updates.md @@ -3,7 +3,7 @@ # withUpdates [common]\ -fun <[DATA](with-updates.md) : Any, [UPDATE](with-updates.md) : Any, [PARAMS](with-updates.md) : Any> [LceModel](-lce-model/index.md)<[DATA](with-updates.md), [PARAMS](with-updates.md)>.[withUpdates](with-updates.md)(serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)> +fun <[DATA](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](-lce-model/index.md)<[DATA](with-updates.md), [PARAMS](with-updates.md)>.[withUpdates](with-updates.md)(serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.coroutines.service/-updating-service-set/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>, ioDispatcher: CoroutineDispatcher = Dispatchers.Unconfined, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)> Wraps an [LceModel](-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](-updating-lce-model/index.md) diff --git a/docs/coroutines/index.md b/docs/coroutines/index.md index 3a75badd..debbb306 100644 --- a/docs/coroutines/index.md +++ b/docs/coroutines/index.md @@ -6,5 +6,6 @@ | Name | |---| +| [[root]](coroutines/[root]/index.md) | | [com.motorro.rxlcemodel.coroutines](coroutines/com.motorro.rxlcemodel.coroutines/index.md) | | [com.motorro.rxlcemodel.coroutines.service](coroutines/com.motorro.rxlcemodel.coroutines.service/index.md) | diff --git a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/-disk-lru-cache-provider.md b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/-disk-lru-cache-provider.md index d874067b..4913848c 100644 --- a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/-disk-lru-cache-provider.md +++ b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/-disk-lru-cache-provider.md @@ -3,7 +3,7 @@ # DiskLruCacheProvider [jvm]\ -fun [DiskLruCacheProvider](-disk-lru-cache-provider.md)(directory: [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html), appVersion: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxSize: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) +constructor(directory: [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html), appVersion: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxSize: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) #### Parameters diff --git a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md index 304f3985..3442a77a 100644 --- a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md +++ b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md @@ -2,7 +2,6 @@ # DiskLruCacheProvider -[jvm]\ class [DiskLruCacheProvider](index.md)(directory: [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html), appVersion: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxSize: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) Provides properly configured DiskLruCache with required entry config @@ -21,7 +20,7 @@ jvm | | | |---|---| -| [DiskLruCacheProvider](-disk-lru-cache-provider.md) | [jvm]
fun [DiskLruCacheProvider](-disk-lru-cache-provider.md)(directory: [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html), appVersion: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxSize: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | +| [DiskLruCacheProvider](-disk-lru-cache-provider.md) | [jvm]
constructor(directory: [File](https://docs.oracle.com/javase/8/docs/api/java/io/File.html), appVersion: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html), maxSize: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)) | ## Properties @@ -29,7 +28,7 @@ jvm |---|---| | [cache](cache.md) | [jvm]
val [cache](cache.md): DiskLruCache
Configured DiskLruCache | -## Extensions +## Functions | Name | Summary | |---|---| diff --git a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-sync-delegate.md b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-sync-delegate.md index e7317e4b..5ec969b8 100644 --- a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-sync-delegate.md +++ b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/-disk-lru-cache-sync-delegate.md @@ -6,7 +6,7 @@ @[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html) -fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate.md)(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sd: [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)>, cacheProvider: [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) +constructor(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sd: [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)>, cacheProvider: [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) #### Parameters diff --git a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/index.md b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/index.md index 3430a27e..d38749a8 100644 --- a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/index.md +++ b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/index.md @@ -2,19 +2,10 @@ # DiskLruCacheSyncDelegate -[jvm]\ class [DiskLruCacheSyncDelegate](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)constructor(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sd: [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)>, cacheProvider: [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [CacheDelegate](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)> DiskLruCache caching delegate for cache services Designed to operate common [cacheProvider](../../../../disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/cache-provider.md) instance together with other delegates to be able to clean-up all cache all-together - say delete user's cache when user logs out Each entry contains: 0 - saved entity 1 - timestamp entity was last updated with `save` 2 - timestamp entity was invalidated with `invalidate` -#### See also - -jvm - -| | -|---| -| [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md) | - #### Parameters jvm @@ -26,11 +17,17 @@ jvm | cacheProvider | Disk LRU cache provider. Opens cache with a proper entry config | | clock | Provides timestamp for cache status marks | +#### See also + +| | +|---| +| [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md) | + ## Constructors | | | |---|---| -| [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate.md) | [jvm]
@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)
fun <[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate.md)(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sd: [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)>, cacheProvider: [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | +| [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate.md) | [jvm]
@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)
constructor(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sd: [CacheDelegateSerializerDeserializer](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](index.md)>, cacheProvider: [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-provider/index.md), clock: [Clock](../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) | ## Types @@ -47,10 +44,5 @@ jvm | [get](get.md) | [jvm]
open override fun [get](get.md)(params: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>?
Returns data if cached | | [invalidate](invalidate.md) | [jvm]
open override fun [invalidate](invalidate.md)(params: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html))
Clears cached value | | [invalidateAll](invalidate-all.md) | [jvm]
open override fun [invalidateAll](invalidate-all.md)()
Invalidates all cached values | -| [save](save.md) | [jvm]
open override fun [save](save.md)(params: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>)
Saves data to cache | - -## Extensions - -| Name | Summary | -|---|---| | [normalizeParams](../normalize-params.md) | [jvm]
fun <[D](../normalize-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](../normalize-params.md) : [CacheFriend](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate](index.md)<[D](../normalize-params.md)>.[normalizeParams](../normalize-params.md)(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](../normalize-params.md), [P](../normalize-params.md)>
Creates an adapter delegate that normalizes [CacheFriend.cacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/cache-key.md) to fit into DiskLruCache requirements of 64 a-zA-Z0-9 symbols | +| [save](save.md) | [jvm]
open override fun [save](save.md)(params: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>)
Saves data to cache | diff --git a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/index.md b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/index.md index 15314ba5..8bc0fc10 100644 --- a/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/index.md +++ b/docs/disklrucache/disklrucache/com.motorro.rxlcemodel.disklrucache/index.md @@ -8,6 +8,12 @@ |---|---| | [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate/index.md) | [jvm]
class [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate/index.md)<[D](-disk-lru-cache-sync-delegate/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>@[JvmOverloads](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-overloads/index.html)constructor(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html), sd: [CacheDelegateSerializerDeserializer](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate-serializer-deserializer/index.md)<[D](-disk-lru-cache-sync-delegate/index.md)>, cacheProvider: [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md), clock: [Clock](../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) : [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](-disk-lru-cache-sync-delegate/index.md), [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)>
DiskLruCache caching delegate for cache services Designed to operate common [cacheProvider](../../../disklrucache/com.motorro.rxlcemodel.disklrucache/-disk-lru-cache-sync-delegate/cache-provider.md) instance together with other delegates to be able to clean-up all cache all-together - say delete user's cache when user logs out Each entry contains: 0 - saved entity 1 - timestamp entity was last updated with `save` 2 - timestamp entity was invalidated with `invalidate` | +## Properties + +| Name | Summary | +|---|---| +| [HEX_CHARS](-h-e-x_-c-h-a-r-s.md) | [jvm]
val [HEX_CHARS](-h-e-x_-c-h-a-r-s.md): [CharArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html)
Hex characters | + ## Functions | Name | Summary | @@ -19,9 +25,3 @@ | [normalizeParams](normalize-params.md) | [jvm]
fun <[D](normalize-params.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [P](normalize-params.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate](-disk-lru-cache-sync-delegate/index.md)<[D](normalize-params.md)>.[normalizeParams](normalize-params.md)(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [CacheDelegate](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-delegate/index.md)<[D](normalize-params.md), [P](normalize-params.md)>
Creates an adapter delegate that normalizes [CacheFriend.cacheKey](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/cache-key.md) to fit into DiskLruCache requirements of 64 a-zA-Z0-9 symbols | | [withObjectStream](with-object-stream.md) | [jvm]
inline fun <[D](with-object-stream.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html), [P](with-object-stream.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withObjectStream](with-object-stream.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), 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-object-stream.md), [P](with-object-stream.md)>
inline fun <[D](with-object-stream.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html), [P](with-object-stream.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withObjectStream](with-object-stream.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-object-stream.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-object-stream.md), [P](with-object-stream.md)>
Creates DiskLRU caching delegate for cache-service that accepts [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) data with cache key normalizing and check | | [withObjectStreamNormalized](with-object-stream-normalized.md) | [jvm]
inline fun <[D](with-object-stream-normalized.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html), [P](with-object-stream-normalized.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withObjectStreamNormalized](with-object-stream-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), 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-object-stream-normalized.md), [P](with-object-stream-normalized.md)>
inline fun <[D](with-object-stream-normalized.md) : [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html), [P](with-object-stream-normalized.md) : [CacheFriend](../../../cache/cache/com.motorro.rxlcemodel.cache/-cache-friend/index.md)> [DiskLruCacheSyncDelegate.DiskLruCacheProvider](-disk-lru-cache-sync-delegate/-disk-lru-cache-provider/index.md).[withObjectStreamNormalized](with-object-stream-normalized.md)(validatorFactory: [EntityValidatorFactory](../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity-validator-factory/index.md), prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) = createDefaultDelegatePrefix(D::class.java), crossinline stringify: [P](with-object-stream-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-object-stream-normalized.md), [P](with-object-stream-normalized.md)>
Creates DiskLRU caching delegate for cache-service that accepts [Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html) data with cache key normalizing and check. | - -## Properties - -| Name | Summary | -|---|---| -| [HEX_CHARS](-h-e-x_-c-h-a-r-s.md) | [jvm]
val [HEX_CHARS](-h-e-x_-c-h-a-r-s.md): [CharArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-array/index.html)
Hex characters | 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 1a6b41e4..48d3ecf0 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> [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md)(dataSerializer: KSerializer<[D](index.md)>) +constructor(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 389f3f67..0dc8c229 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>(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](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)>> Serializer for [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md) @@ -13,18 +13,18 @@ Serializer for [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel | | | |---|---| -| [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)>) | +| [DataWithCacheKeySerializer](-data-with-cache-key-serializer.md) | [jvm]
constructor(dataSerializer: KSerializer<[D](index.md)>) | -## Functions +## Properties | Name | Summary | |---|---| -| [deserialize](deserialize.md) | [jvm]
open override fun [deserialize](deserialize.md)(decoder: Decoder): [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)> | -| [serialize](serialize.md) | [jvm]
open override fun [serialize](serialize.md)(encoder: Encoder, value: [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>) | +| [dataSerializer](data-serializer.md) | [jvm]
val [dataSerializer](data-serializer.md): KSerializer<[D](index.md)> | +| [descriptor](descriptor.md) | [jvm]
open override val [descriptor](descriptor.md): SerialDescriptor | -## Properties +## Functions | Name | Summary | |---|---| -| [dataSerializer](data-serializer.md) | [jvm]
val [dataSerializer](data-serializer.md): KSerializer<[D](index.md)> | -| [descriptor](descriptor.md) | [jvm]
open override val [descriptor](descriptor.md): SerialDescriptor | +| [deserialize](deserialize.md) | [jvm]
open override fun [deserialize](deserialize.md)(decoder: Decoder): [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)> | +| [serialize](serialize.md) | [jvm]
open override fun [serialize](serialize.md)(encoder: Encoder, value: [DataWithCacheKey](../../../../cache/cache/com.motorro.rxlcemodel.cache/-data-with-cache-key/index.md)<[D](index.md)>) | 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 9998135a..71ad1524 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> [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) +constructor(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 03d15525..3ba940d6 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, invalidated: Boolean): [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](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 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 13ff061b..c9bf51c8 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 @@ -2,10 +2,9 @@ # KotlinCacheDelegateSerializer -[jvm]\ @ExperimentalSerializationApi -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)> +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)> Serializes and deserializes objects with kotlinx.serialization.KSerializer @@ -23,11 +22,11 @@ jvm | | | |---|---| -| [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) | +| [KotlinCacheDelegateSerializer](-kotlin-cache-delegate-serializer.md) | [jvm]
constructor(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, 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 | +| [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 | | [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 a1a8d88d..435db617 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>(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 | +| [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 | ## Functions | Name | Summary | |---|---| -| [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. | +| [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. | 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 075dde8a..8c73cfcb 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, [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)> +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)> 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, [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)> +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. 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 4a656481..ef810ab7 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, [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)> +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)> 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, [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)> +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 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 d6652490..ae3210e5 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> [Content](-content.md)(data: [DATA](index.md), dataIsValid: Boolean) +constructor(data: [DATA](index.md), dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) 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 78828031..36e80a61 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 +open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) 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 b8e9f0b9..bdbbd843 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>(val data: [DATA](index.md), val dataIsValid: Boolean) : [LceState](../index.md)<[DATA](index.md)> +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 is loaded and content is displayed @@ -11,29 +11,24 @@ Data is loaded and content is displayed | | | |---|---| -| [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): [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 | +| [Content](-content.md) | [common]
constructor(data: [DATA](index.md), dataIsValid: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)) | ## Properties | 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
Data validity at the time of emission | +| [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 | -## Extensions +## Functions | Name | Summary | |---|---| -| [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) | +| [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 | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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](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) | +| [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 | +| [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 | 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 de0adc87..94d5d89c 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> [Error](-error.md)(data: [DATA](index.md)?, dataIsValid: Boolean, error: Throwable) +constructor(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)) 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 03292e34..a6abfdc8 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 +open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) 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 205ebfbe..3d912b85 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 +val [error](error.md): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html) 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 964f162d..653bd3f0 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>(val data: [DATA](index.md)?, val dataIsValid: Boolean, val error: Throwable) : [LceState](../index.md)<[DATA](index.md)> +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 (or part of it) failed to load @@ -11,30 +11,25 @@ Data (or part of it) failed to load | | | |---|---| -| [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): [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 | +| [Error](-error.md) | [common]
constructor(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)) | ## Properties | 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
Data validity at the time of emission | -| [error](error.md) | [common]
val [error](error.md): Throwable
Data load error | +| [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 | -## Extensions +## Functions | Name | Summary | |---|---| -| [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) | +| [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 | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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](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) | +| [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 | +| [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 | 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 f5785aae..f315b7e7 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> [Loading](-loading.md)(data: [DATA](index.md)?, dataIsValid: Boolean, type: [LceState.Loading.Type](-type/index.md) = Type.LOADING) +constructor(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) 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 709956a5..d30a1a71 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 | -| [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 | +| [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) | 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 2329ee68..293d72b8 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 | -| [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 | +| [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) | 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 fd766ff5..48fc1d94 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 | -| [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 | +| [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) | 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 58429426..b0ca6d29 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 | -| [ordinal](index.md#-739389684%2FProperties%2F-702262346) | [common]
val [ordinal](index.md#-739389684%2FProperties%2F-702262346): Int | +| [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) | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/entries.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/entries.md new file mode 100644 index 00000000..516a488e --- /dev/null +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/entries.md @@ -0,0 +1,10 @@ +//[lce](../../../../../index.md)/[com.motorro.rxlcemodel.lce](../../../index.md)/[LceState](../../index.md)/[Loading](../index.md)/[Type](index.md)/[entries](entries.md) + +# entries + +[common]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[LceState.Loading.Type](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. 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 83f74326..2c44fef8 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<[LceState.Loading.Type](index.md)> +enum [Type](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html)<[LceState.Loading.Type](index.md)> Loading type @@ -16,16 +16,17 @@ Loading type | [REFRESHING](-r-e-f-r-e-s-h-i-n-g/index.md) | [common]
[REFRESHING](-r-e-f-r-e-s-h-i-n-g/index.md)
Refreshing content | | [UPDATING](-u-p-d-a-t-i-n-g/index.md) | [common]
[UPDATING](-u-p-d-a-t-i-n-g/index.md)
Updating data on server | -## Functions +## Properties | Name | Summary | |---|---| -| [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. | +| [entries](entries.md) | [common]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[LceState.Loading.Type](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [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) | -## Properties +## Functions | 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 | -| [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 | +| [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. | 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 2b8b59f2..361958dd 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): [LceState.Loading.Type](index.md) +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.) @@ -11,4 +11,4 @@ Returns the enum constant of this type with the specified name. The string must | | | |---|---| -| IllegalArgumentException | if this enum type has no constant with the specified name | +| [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 | 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 b471a2fd..d861f67c 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<[LceState.Loading.Type](index.md)> +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. 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 f5510293..de187683 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 +open override val [dataIsValid](data-is-valid.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) 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 7d463f39..7d55ee40 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>(val data: [DATA](index.md)?, val dataIsValid: Boolean, 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](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)> View is loading @@ -11,36 +11,31 @@ View is 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) | +| [Loading](-loading.md) | [common]
constructor(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) | ## Types | Name | Summary | |---|---| -| [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): [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 | +| [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 | ## Properties | 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
Data validity at the time of emission | +| [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 | | [type](type.md) | [common]
val [type](type.md): [LceState.Loading.Type](-type/index.md)
Loading type | -## Extensions +## Functions | Name | Summary | |---|---| -| [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) | +| [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 | | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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](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) | +| [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 | +| [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 | 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 418b904e..501c29fb 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 = false +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). 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 aa523a8e..02868f34 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? = null +open override val [data](data.md): [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)? = 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 c56aca61..baaf1e95 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?): Boolean +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) 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 9f3c43d7..e523c188 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 +open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) 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 1b0d1354..897e7e54 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,33 +3,28 @@ # Terminated [common]\ -object [Terminated](index.md) : [LceState](../index.md)<Nothing> +object [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](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 | -|---|---| -| [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? = 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). | +| [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). | -## Extensions +## Functions | Name | Summary | |---|---| -| [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) | +| [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 | | +| [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) | +| [flatMap](../../flat-map.md) | [common]
inline fun <[DATA_1](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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 | | +| [hashCode](hash-code.md) | [common]
open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [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) | +| [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 | 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 d2d8c203..bb26ef0d 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 +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). 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 7fbb75fd..5d2556b1 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 @@ -2,8 +2,7 @@ # LceState -[common]\ -sealed class [LceState](index.md)<out [DATA](index.md) : Any> +sealed class [LceState](index.md)<out [DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> State for "Loading-Content-Error" resource which retrieves [data](data.md) @@ -15,45 +14,40 @@ common |---|---| | DATA | Data Type of data being held | -## Types +#### Inheritors -| Name | Summary | -|---|---| -| [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. | +| | +|---| +| [Loading](-loading/index.md) | +| [Content](-content/index.md) | +| [Error](-error/index.md) | +| [Terminated](-terminated/index.md) | -## Functions +## Types | Name | Summary | |---|---| -| [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 | +| [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. | ## Properties | 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
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 - -| Name | -|---| -| [Loading](-loading/index.md) | -| [Content](-content/index.md) | -| [Error](-error/index.md) | -| [Terminated](-terminated/index.md) | +| [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). | -## Extensions +## Functions | Name | Summary | |---|---| -| [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) | +| [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 | | +| [flatMap](../flat-map.md) | [common]
inline fun <[DATA_1](../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](../flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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](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) | +| [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 | +| [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 | 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 04214480..01d4e2b0 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): [LceState.Error](-error/index.md)<[DATA](index.md)> +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 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 20bf7f22..b8b62d80 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, [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)> +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): diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/combine.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/combine.md index 0e88e201..24c9adeb 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, [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)> +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 | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md index 76ced01e..12080d05 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/flat-map.md @@ -3,7 +3,7 @@ # 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)> +inline fun <[DATA_1](flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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 | diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md index ca971ab6..5461d361 100644 --- a/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md +++ b/docs/lce/lce/com.motorro.rxlcemodel.lce/index.md @@ -6,15 +6,15 @@ | Name | Summary | |---|---| -| [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) | +| [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) | ## Functions | Name | Summary | |---|---| -| [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) | +| [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 | | +| [flatMap](flat-map.md) | [common]
inline fun <[DATA_1](flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [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](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) | 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 8f631864..97cd2b21 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> [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](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) 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 4e2fbf49..dd641282 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> [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](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) diff --git a/docs/lce/lce/com.motorro.rxlcemodel.lce/map.md b/docs/lce/lce/com.motorro.rxlcemodel.lce/map.md index 347f05a2..2c465728 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, [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)> +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 diff --git a/docs/package-list b/docs/package-list index 419f8888..622d678f 100644 --- a/docs/package-list +++ b/docs/package-list @@ -1,5 +1,7 @@ $dokka.format:gfm-v1 $dokka.linkExtension:md +$dokka.location:////PointingToDeclaration/coroutines/coroutines/[root]/index.md +$dokka.location://coroutinesRunCatching/TypeParam(bounds=[kotlin.Any?])#kotlin.Function1[TypeParam(bounds=[kotlin.Any?]),TypeParam(bounds=[kotlin.Any?])]/PointingToDeclaration/coroutines/coroutines/[root]/coroutines-run-catching.md $dokka.location:com.motorro.rxlcemodel.cache.entity////PointingToDeclaration/cache/cache/com.motorro.rxlcemodel.cache.entity/index.md $dokka.location:com.motorro.rxlcemodel.cache.entity//toEntity/TypeParam(bounds=[kotlin.Any])#com.motorro.rxlcemodel.cache.entity.EntityValidator/PointingToDeclaration/cache/cache/com.motorro.rxlcemodel.cache.entity/to-entity.md $dokka.location:com.motorro.rxlcemodel.cache.entity/Entity.Impl///PointingToDeclaration/cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/-impl/index.md @@ -110,6 +112,7 @@ $dokka.location:com.motorro.rxlcemodel.common/LogLevel.ERROR///PointingToDeclara $dokka.location:com.motorro.rxlcemodel.common/LogLevel.INFO///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}utils/utils/com.motorro.rxlcemodel.common/-log-level/-i-n-f-o/index.md $dokka.location:com.motorro.rxlcemodel.common/LogLevel.WARNING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}utils/utils/com.motorro.rxlcemodel.common/-log-level/-w-a-r-n-i-n-g/index.md $dokka.location:com.motorro.rxlcemodel.common/LogLevel///PointingToDeclaration/utils/utils/com.motorro.rxlcemodel.common/-log-level/index.md +$dokka.location:com.motorro.rxlcemodel.common/LogLevel/entries/#/PointingToDeclaration/utils/utils/com.motorro.rxlcemodel.common/-log-level/entries.md $dokka.location:com.motorro.rxlcemodel.common/LogLevel/valueOf/#kotlin.String/PointingToDeclaration/utils/utils/com.motorro.rxlcemodel.common/-log-level/value-of.md $dokka.location:com.motorro.rxlcemodel.common/LogLevel/values/#/PointingToDeclaration/utils/utils/com.motorro.rxlcemodel.common/-log-level/values.md $dokka.location:com.motorro.rxlcemodel.common/Logger///PointingToDeclaration/utils/utils/com.motorro.rxlcemodel.common/-logger/index.md @@ -124,7 +127,7 @@ $dokka.location:com.motorro.rxlcemodel.common/UpdateOperationState.LOADING///Poi $dokka.location:com.motorro.rxlcemodel.common/UpdateOperationState.LOADING/toString/#/PointingToDeclaration/common/common/com.motorro.rxlcemodel.common/-update-operation-state/-l-o-a-d-i-n-g/to-string.md $dokka.location:com.motorro.rxlcemodel.common/UpdateOperationState///PointingToDeclaration/common/common/com.motorro.rxlcemodel.common/-update-operation-state/index.md $dokka.location:com.motorro.rxlcemodel.composeview.view////PointingToDeclaration/composeview/composeview/com.motorro.rxlcemodel.composeview.view/index.md -$dokka.location:com.motorro.rxlcemodel.composeview.view//SwipeRefresh/#kotlin.Boolean#kotlin.Function0[kotlin.Unit]#kotlin.Function0[kotlin.Unit]/PointingToDeclaration/composeview/composeview/com.motorro.rxlcemodel.composeview.view/-swipe-refresh.md +$dokka.location:com.motorro.rxlcemodel.composeview.view//SwipeRefresh/#kotlin.Boolean#kotlin.Function0[kotlin.Unit]#kotlin.Function1[kotlin.Boolean,kotlin.Unit]/PointingToDeclaration/composeview/composeview/com.motorro.rxlcemodel.composeview.view/-swipe-refresh.md $dokka.location:com.motorro.rxlcemodel.composeview////PointingToDeclaration/composeview/composeview/com.motorro.rxlcemodel.composeview/index.md $dokka.location:com.motorro.rxlcemodel.composeview//LceStateView/#com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]#kotlin.Function0[kotlin.Unit]#kotlin.Function0[kotlin.Unit]#kotlin.Function1[kotlin.Throwable,kotlin.Unit]#kotlin.Function1[kotlin.Throwable,kotlin.Unit]#kotlin.Function0[kotlin.Unit]#kotlin.Function1[com.motorro.rxlcemodel.lce.LceState.Error[TypeParam(bounds=[kotlin.Any])],kotlin.Boolean]#kotlin.Function3[TypeParam(bounds=[kotlin.Any]),kotlin.Boolean,kotlin.Boolean,kotlin.Unit]/PointingToDeclaration/composeview/composeview/com.motorro.rxlcemodel.composeview/-lce-state-view.md $dokka.location:com.motorro.rxlcemodel.composeview//initializeModel/#androidx.lifecycle.ViewModelStoreOwner#kotlin.Function1[TypeParam(bounds=[com.motorro.rxlcemodel.viewmodel.BaseLceModel[TypeParam(bounds=[kotlin.Any])]]),kotlin.Unit]/PointingToDeclaration/composeview/composeview/com.motorro.rxlcemodel.composeview/initialize-model.md @@ -161,6 +164,7 @@ $dokka.location:com.motorro.rxlcemodel.coroutines//dataNoErrors/kotlinx.coroutin $dokka.location:com.motorro.rxlcemodel.coroutines//dataStopOnEmptyErrors/kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-empty-errors.md $dokka.location:com.motorro.rxlcemodel.coroutines//dataStopOnErrors/kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/data-stop-on-errors.md $dokka.location:com.motorro.rxlcemodel.coroutines//errorToLce/kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.Function1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any])?]/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/error-to-lce.md +$dokka.location:com.motorro.rxlcemodel.coroutines//flatMapLatestFlow/kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.coroutines.SuspendFunction1[TypeParam(bounds=[kotlin.Any]),kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]]/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-latest-flow.md $dokka.location:com.motorro.rxlcemodel.coroutines//flatMapSingleData/kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.coroutines.SuspendFunction1[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/flat-map-single-data.md $dokka.location:com.motorro.rxlcemodel.coroutines//getData/kotlinx.coroutines.flow.Flow[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.Function1[com.motorro.rxlcemodel.lce.LceState.Error[TypeParam(bounds=[kotlin.Any])],kotlin.Boolean]/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/get-data.md $dokka.location:com.motorro.rxlcemodel.coroutines//map/com.motorro.rxlcemodel.coroutines.LceModel[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/coroutines/coroutines/com.motorro.rxlcemodel.coroutines/map.md @@ -259,6 +263,7 @@ $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type.LOADING_MORE/// $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type.REFRESHING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-r-e-f-r-e-s-h-i-n-g/index.md $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type.UPDATING///PointingToDeclaration/{"org.jetbrains.dokka.links.EnumEntryDRIExtra":{"key":"org.jetbrains.dokka.links.EnumEntryDRIExtra"}}lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/-u-p-d-a-t-i-n-g/index.md $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type///PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/index.md +$dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type/entries/#/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/entries.md $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type/valueOf/#kotlin.String/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/value-of.md $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading.Type/values/#/PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/-type/values.md $dokka.location:com.motorro.rxlcemodel.lce/LceState.Loading///PointingToDeclaration/lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-loading/index.md @@ -309,6 +314,7 @@ $dokka.location:com.motorro.rxlcemodel.rx//dataNoErrors/io.reactivex.rxjava3.cor $dokka.location:com.motorro.rxlcemodel.rx//dataStopOnEmptyErrors/io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/data-stop-on-empty-errors.md $dokka.location:com.motorro.rxlcemodel.rx//dataStopOnErrors/io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/data-stop-on-errors.md $dokka.location:com.motorro.rxlcemodel.rx//errorToLce/io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.Function1[kotlin.Throwable,TypeParam(bounds=[kotlin.Any])?]/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/error-to-lce.md +$dokka.location:com.motorro.rxlcemodel.rx//flatMapLatestFlow/io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.Function1[TypeParam(bounds=[kotlin.Any]),io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]]/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/flat-map-latest-flow.md $dokka.location:com.motorro.rxlcemodel.rx//flatMapSingleData/io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.Function1[TypeParam(bounds=[kotlin.Any]),io.reactivex.rxjava3.core.Single[TypeParam(bounds=[kotlin.Any])]]/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/flat-map-single-data.md $dokka.location:com.motorro.rxlcemodel.rx//getData/io.reactivex.rxjava3.core.Observable[com.motorro.rxlcemodel.lce.LceState[TypeParam(bounds=[kotlin.Any])]]#kotlin.Function1[com.motorro.rxlcemodel.lce.LceState.Error[TypeParam(bounds=[kotlin.Any])],kotlin.Boolean]/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/get-data.md $dokka.location:com.motorro.rxlcemodel.rx//map/com.motorro.rxlcemodel.rx.LceModel[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration/rx/rx/com.motorro.rxlcemodel.rx/map.md diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-cache-service/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-cache-service/index.md index 3c3b4cf4..276450f4 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-cache-service/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-cache-service/index.md @@ -2,7 +2,6 @@ # CacheService -[jvm]\ interface [CacheService](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Interface to cache an [com.motorro.rxlcemodel.cache.entity.Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) locally Cache should notify subscribers that data has been updated through [getData](get-data.md) channel @@ -16,12 +15,25 @@ jvm | D | Data type | | P | Params that identify data type | +#### Inheritors + +| | +|---| +| [SyncDelegateCacheService](../-sync-delegate-cache-service/index.md) | + ## Types | Name | Summary | |---|---| | [Companion](-companion/index.md) | [jvm]
object [Companion](-companion/index.md) | +## Properties + +| Name | Summary | +|---|---| +| [invalidateAll](invalidate-all.md) | [jvm]
abstract val [invalidateAll](invalidate-all.md): Completable
Invalidates all cached values | +| [refetchAll](refetch-all.md) | [jvm]
abstract val [refetchAll](refetch-all.md): Completable
Makes cache service to refetch cached data for all active subscribers | + ## Functions | Name | Summary | @@ -31,16 +43,3 @@ jvm | [invalidate](invalidate.md) | [jvm]
abstract fun [invalidate](invalidate.md)(params: [P](index.md)): Completable
Invalidates cached value | | [refetch](refetch.md) | [jvm]
abstract fun [refetch](refetch.md)(params: [P](index.md)): Completable
Makes cache service to refetch cached data updating subscribers with [params](refetch.md) | | [save](save.md) | [jvm]
abstract fun [save](save.md)(params: [P](index.md), entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>): Completable
Saves entity in a cache | - -## Properties - -| Name | Summary | -|---|---| -| [invalidateAll](invalidate-all.md) | [jvm]
abstract val [invalidateAll](invalidate-all.md): Completable
Invalidates all cached values | -| [refetchAll](refetch-all.md) | [jvm]
abstract val [refetchAll](refetch-all.md): Completable
Makes cache service to refetch cached data for all active subscribers | - -## Inheritors - -| Name | -|---| -| [SyncDelegateCacheService](../-sync-delegate-cache-service/index.md) | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-net-service/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-net-service/index.md index f30a8379..2b3e1ebd 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-net-service/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-net-service/index.md @@ -2,7 +2,6 @@ # NetService -[jvm]\ interface [NetService](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Interface to load an [com.motorro.rxlcemodel.cache.entity.Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md) from network @@ -16,14 +15,14 @@ jvm | D | Data type | | P | Params that identify data type | +#### Inheritors + +| | +|---| +| [UpdatingNetService](../-updating-net-service/index.md) | + ## Functions | Name | Summary | |---|---| | [get](get.md) | [jvm]
abstract fun [get](get.md)(params: [P](index.md)): Single<[Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>>
Gets entity from network or throws on error | - -## Inheritors - -| Name | -|---| -| [UpdatingNetService](../-updating-net-service/index.md) | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-service-set/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-service-set/index.md index a1a1ebf3..005a079b 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-service-set/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-service-set/index.md @@ -2,7 +2,6 @@ # ServiceSet -[jvm]\ interface [ServiceSet](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Service-set for [com.motorro.rxlcemodel.rx.LceModel](../../com.motorro.rxlcemodel.rx/-lce-model/index.md) @@ -16,15 +15,15 @@ jvm | D | Data type | | P | Params that identify data type | +#### Inheritors + +| | +|---| +| [UpdatingServiceSet](../-updating-service-set/index.md) | + ## Properties | Name | Summary | |---|---| | [cache](cache.md) | [jvm]
abstract val [cache](cache.md): [CacheService](../-cache-service/index.md)<[D](index.md), [P](index.md)>
Cache service | | [net](net.md) | [jvm]
abstract val [net](net.md): [NetService](../-net-service/index.md)<[D](index.md), [P](index.md)>
Net service | - -## Inheritors - -| Name | -|---| -| [UpdatingServiceSet](../-updating-service-set/index.md) | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-sync-delegate-cache-service/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-sync-delegate-cache-service/index.md index f2a7bcdb..091885f8 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-sync-delegate-cache-service/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-sync-delegate-cache-service/index.md @@ -2,7 +2,6 @@ # SyncDelegateCacheService -[jvm]\ class [SyncDelegateCacheService](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)> : [CacheService](../-cache-service/index.md)<[D](index.md), [P](index.md)> Service implementation @@ -15,6 +14,13 @@ jvm |---|---| | delegate | Delegate to perform concrete caching operations | +## Properties + +| Name | Summary | +|---|---| +| [invalidateAll](invalidate-all.md) | [jvm]
open override val [invalidateAll](invalidate-all.md): Completable
Invalidates all cached values | +| [refetchAll](refetch-all.md) | [jvm]
open override val [refetchAll](refetch-all.md): Completable
Makes cache service to refetch cached data for all active subscribers | + ## Functions | Name | Summary | @@ -24,10 +30,3 @@ jvm | [invalidate](invalidate.md) | [jvm]
open override fun [invalidate](invalidate.md)(params: [P](index.md)): Completable
Clears cached value | | [refetch](refetch.md) | [jvm]
open override fun [refetch](refetch.md)(params: [P](index.md)): Completable
Makes cache service to refetch cached data updating subscribers with [params](refetch.md) | | [save](save.md) | [jvm]
open override fun [save](save.md)(params: [P](index.md), entity: [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[D](index.md)>): Completable
Saves entity in a cache | - -## Properties - -| Name | Summary | -|---|---| -| [invalidateAll](invalidate-all.md) | [jvm]
open override val [invalidateAll](invalidate-all.md): Completable
Invalidates all cached values | -| [refetchAll](refetch-all.md) | [jvm]
open override val [refetchAll](refetch-all.md): Completable
Makes cache service to refetch cached data for all active subscribers | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-net-service/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-net-service/index.md index 56314477..2e9bff2e 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-net-service/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-net-service/index.md @@ -2,7 +2,6 @@ # UpdatingNetService -[jvm]\ interface [UpdatingNetService](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [U](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [NetService](../-net-service/index.md)<[D](index.md), [P](index.md)> [NetService](../-net-service/index.md) extension to update data on server diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md index 69a4bdbf..d2fbf364 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md @@ -2,7 +2,6 @@ # UpdatingServiceSet -[jvm]\ interface [UpdatingServiceSet](index.md)<[D](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [U](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [P](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [ServiceSet](../-service-set/index.md)<[D](index.md), [P](index.md)> [ServiceSet](../-service-set/index.md) extension with updating [net](net.md) diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/-cache-then-net-lce-model.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/-cache-then-net-lce-model.md index 3d3f9adf..9c8afe5e 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/-cache-then-net-lce-model.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/-cache-then-net-lce-model.md @@ -3,7 +3,7 @@ # CacheThenNetLceModel [jvm]\ -fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheThenNetLceModel](-cache-then-net-lce-model.md)(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.rx.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.rx.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/index.md index 71dc9b48..2c0dd6b7 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-cache-then-net-lce-model/index.md @@ -2,7 +2,6 @@ # CacheThenNetLceModel -[jvm]\ class [CacheThenNetLceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(val params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.rx.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> A [LceModel](../-lce-model/index.md) which uses cache subscription as a 'source of truth'. When [state](state.md) is subscribed it loads cache data refreshing it if cache is stall or whenever cache returns empty [java.util.Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html). The model always returns cached data first - then network if data is stall Cache service *must* notify of its data changes! @@ -25,7 +24,7 @@ jvm | | | |---|---| -| [CacheThenNetLceModel](-cache-then-net-lce-model.md) | [jvm]
fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [CacheThenNetLceModel](-cache-then-net-lce-model.md)(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.rx.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | +| [CacheThenNetLceModel](-cache-then-net-lce-model.md) | [jvm]
constructor(params: [PARAMS](index.md), serviceSet: [ServiceSet](../../com.motorro.rxlcemodel.rx.service/-service-set/index.md)<[DATA](index.md), [PARAMS](index.md)>, startWith: Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -35,7 +34,7 @@ jvm | [refresh](refresh.md) | [jvm]
open override val [refresh](refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](state.md) | [jvm]
open override val [state](state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Extensions +## Functions | Name | Summary | |---|---| diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-model/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-model/index.md index 60b75b8a..70180660 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-model/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-model/index.md @@ -2,7 +2,6 @@ # LceModel -[jvm]\ interface [LceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceUseCase](../-lce-use-case/index.md)<[DATA](index.md)> A model interface to load data and transmit it to subscribers along with loading operation state @@ -16,6 +15,14 @@ jvm | DATA | Data type of data being loaded | | PARAMS | Params type that identify data being loaded | +#### Inheritors + +| | +|---| +| [CacheThenNetLceModel](../-cache-then-net-lce-model/index.md) | +| [UpdatingLceModel](../-updating-lce-model/index.md) | +| [UpdateWrapper](../-update-wrapper/index.md) | + ## Types | Name | Summary | @@ -30,15 +37,7 @@ jvm | [refresh](../-lce-use-case/refresh.md) | [jvm]
abstract val [refresh](../-lce-use-case/refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](../-lce-use-case/state.md) | [jvm]
abstract val [state](../-lce-use-case/state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Inheritors - -| Name | -|---| -| [CacheThenNetLceModel](../-cache-then-net-lce-model/index.md) | -| [UpdatingLceModel](../-updating-lce-model/index.md) | -| [UpdateWrapper](../-update-wrapper/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md index 5d6058d7..fda30997 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md @@ -2,7 +2,6 @@ # LceUseCase -[jvm]\ interface [LceUseCase](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Base LCE use-case with [state](state.md) and [refresh](refresh.md) @@ -15,6 +14,12 @@ jvm |---|---| | DATA | Data type of data being loaded | +#### Inheritors + +| | +|---| +| [LceModel](../-lce-model/index.md) | + ## Properties | Name | Summary | @@ -22,13 +27,7 @@ jvm | [refresh](refresh.md) | [jvm]
abstract val [refresh](refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](state.md) | [jvm]
abstract val [state](state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Inheritors - -| Name | -|---| -| [LceModel](../-lce-model/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/-strategy-update-wrapper.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/-strategy-update-wrapper.md index 8c036f93..1e98da12 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/-strategy-update-wrapper.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/-strategy-update-wrapper.md @@ -3,7 +3,7 @@ # StrategyUpdateWrapper [jvm]\ -fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [StrategyUpdateWrapper](-strategy-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/index.md index 138c58f4..ac88b26d 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/index.md @@ -2,7 +2,6 @@ # StrategyUpdateWrapper -[jvm]\ class [StrategyUpdateWrapper](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](../-update-wrapper/index.md)<[DATA](index.md), [PARAMS](index.md)> Wraps [LceModel](../-lce-model/index.md) and mixes in a data update state Use to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../../rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/do-update.md) template @@ -24,13 +23,7 @@ jvm | | | |---|---| -| [StrategyUpdateWrapper](-strategy-update-wrapper.md) | [jvm]
fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [StrategyUpdateWrapper](-strategy-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | - -## Functions - -| Name | Summary | -|---|---| -| [update](update.md) | [jvm]
fun [update](update.md)(dataSource: (params: [PARAMS](index.md)) -> Single<out [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DATA](index.md)>>): Completable
Creates a cache-update operation that gets data from [dataSource](update.md) and saves to cache. The completable updates [networkOperationState](../../../../rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/network-operation-state.md) to mix state to original [upstream](../../../../rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/upstream.md) | +| [StrategyUpdateWrapper](-strategy-update-wrapper.md) | [jvm]
constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -40,11 +33,12 @@ jvm | [refresh](../-lce-use-case/refresh.md) | [jvm]
open override val [refresh](../-lce-use-case/refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](../-update-wrapper/state.md) | [jvm]
open override val [state](../-update-wrapper/state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](../../../../rx/com.motorro.rxlcemodel.rx/-update-wrapper/upstream.md) emissions with update operation status. | -## Extensions +## Functions | Name | Summary | |---|---| | [map](../map.md) | [jvm]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[jvm]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | | [refreshed](../refreshed.md) | [jvm]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [update](update.md) | [jvm]
fun [update](update.md)(dataSource: (params: [PARAMS](index.md)) -> Single<out [Entity](../../../../cache/cache/com.motorro.rxlcemodel.cache.entity/-entity/index.md)<[DATA](index.md)>>): Completable
Creates a cache-update operation that gets data from [dataSource](update.md) and saves to cache. The completable updates [networkOperationState](../../../../rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/network-operation-state.md) to mix state to original [upstream](../../../../rx/com.motorro.rxlcemodel.rx/-strategy-update-wrapper/upstream.md) | | [withRefresh](../with-refresh.md) | [jvm]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Observable<in [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../rx/com.motorro.rxlcemodel.rx/-lce-model/refresh.md) property becomes invisible for the outside world | | [withUpdates](../with-updates.md) | [jvm]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioScheduler: Scheduler = Schedulers.trampoline(), logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/-update-wrapper.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/-update-wrapper.md index 3fdc2b5f..5e24cf76 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/-update-wrapper.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/-update-wrapper.md @@ -3,7 +3,7 @@ # UpdateWrapper [jvm]\ -fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [UpdateWrapper](-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/index.md index 7d1d3009..e1292e58 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-update-wrapper/index.md @@ -2,7 +2,6 @@ # UpdateWrapper -[jvm]\ abstract class [UpdateWrapper](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> A base class that wraps [LceModel](../-lce-model/index.md) and mixes in a data update state Extend to build models that patch some properties and load the whole data structure as a result Implement methods to update properties using [doUpdate](../../../../rx/com.motorro.rxlcemodel.rx/-update-wrapper/do-update.md) template @@ -20,11 +19,18 @@ jvm | ioScheduler | Scheduler to run IO operations | | logger | Logging function | +#### Inheritors + +| | +|---| +| [StrategyUpdateWrapper](../-strategy-update-wrapper/index.md) | +| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | + ## Constructors | | | |---|---| -| [UpdateWrapper](-update-wrapper.md) | [jvm]
fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [UpdateWrapper](-update-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | +| [UpdateWrapper](-update-wrapper.md) | [jvm]
constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, cacheService: [CacheService](../../com.motorro.rxlcemodel.rx.service/-cache-service/index.md)<[DATA](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -34,14 +40,7 @@ jvm | [refresh](../-lce-use-case/refresh.md) | [jvm]
open override val [refresh](../-lce-use-case/refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](state.md) | [jvm]
open override val [state](state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](../../../../rx/com.motorro.rxlcemodel.rx/-update-wrapper/upstream.md) emissions with update operation status. | -## Inheritors - -| Name | -|---| -| [StrategyUpdateWrapper](../-strategy-update-wrapper/index.md) | -| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md index 8393f84d..f8efec05 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/-updating-lce-model-wrapper.md @@ -3,7 +3,7 @@ # UpdatingLceModelWrapper [jvm]\ -fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) +constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) #### Parameters diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/index.md index 7aabe33a..f299f86e 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model-wrapper/index.md @@ -2,19 +2,10 @@ # UpdatingLceModelWrapper -[jvm]\ class [UpdatingLceModelWrapper](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](../-update-wrapper/index.md)<[DATA](index.md), [PARAMS](index.md)> , [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)> Wraps an [LceModel](../-lce-model/index.md) to enable simple data updates with the [UPDATE](index.md) structure (say a PUT operation) rather than individual property updates (PATCH operation). Implement [UpdateWrapper](../-update-wrapper/index.md) to achieve PATCH workflow -#### See also - -jvm - -| | -|---| -| [UpdateWrapper](../-update-wrapper/index.md) | - #### Parameters jvm @@ -29,17 +20,17 @@ jvm | ioScheduler | Scheduler to run IO operations | | logger | Logging function | -## Constructors +#### See also -| | | -|---|---| -| [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md) | [jvm]
fun <[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md)(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | +| | +|---| +| [UpdateWrapper](../-update-wrapper/index.md) | -## Functions +## Constructors -| Name | Summary | +| | | |---|---| -| [update](update.md) | [jvm]
open override fun [update](update.md)(update: [UPDATE](index.md)): Completable
Updates data on server and refreshes local data | +| [UpdatingLceModelWrapper](-updating-lce-model-wrapper.md) | [jvm]
constructor(upstream: [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)>, serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](index.md), [UPDATE](index.md), [PARAMS](index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) | ## Properties @@ -49,11 +40,12 @@ jvm | [refresh](../-lce-use-case/refresh.md) | [jvm]
open override val [refresh](../-lce-use-case/refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](../-update-wrapper/state.md) | [jvm]
open override val [state](../-update-wrapper/state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates Wrapper mixes the [upstream](../../../../rx/com.motorro.rxlcemodel.rx/-update-wrapper/upstream.md) emissions with update operation status. | -## Extensions +## Functions | Name | Summary | |---|---| | [map](../map.md) | [jvm]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[jvm]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | | [refreshed](../refreshed.md) | [jvm]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [update](update.md) | [jvm]
open override fun [update](update.md)(update: [UPDATE](index.md)): Completable
Updates data on server and refreshes local data | | [withRefresh](../with-refresh.md) | [jvm]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Observable<in [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../rx/com.motorro.rxlcemodel.rx/-lce-model/refresh.md) property becomes invisible for the outside world | | [withUpdates](../with-updates.md) | [jvm]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioScheduler: Scheduler = Schedulers.trampoline(), logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](../-updating-lce-model/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](../-updating-lce-model/index.md) | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model/index.md index bbecf3c3..01889251 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/-updating-lce-model/index.md @@ -2,7 +2,6 @@ # UpdatingLceModel -[jvm]\ interface [UpdatingLceModel](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceModel](../-lce-model/index.md)<[DATA](index.md), [PARAMS](index.md)> [LceModel](../-lce-model/index.md) extension that can [update](update.md) data @@ -17,11 +16,11 @@ jvm | UPDATE | Update type | | PARAMS | Params type that identify data being loaded | -## Functions +#### Inheritors -| Name | Summary | -|---|---| -| [update](update.md) | [jvm]
abstract fun [update](update.md)(update: [UPDATE](index.md)): Completable
Updates data on server and refreshes local data | +| | +|---| +| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | ## Properties @@ -31,17 +30,12 @@ jvm | [refresh](../-lce-use-case/refresh.md) | [jvm]
abstract val [refresh](../-lce-use-case/refresh.md): Completable
Requests a refresh of data. Data will be updated asynchronously | | [state](../-lce-use-case/state.md) | [jvm]
abstract val [state](../-lce-use-case/state.md): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](index.md)>>
Model state. Subscription starts data load for the first subscriber. Whenever last subscriber cancels, the model unsubscribes internal components for data updates | -## Inheritors - -| Name | -|---| -| [UpdatingLceModelWrapper](../-updating-lce-model-wrapper/index.md) | - -## Extensions +## Functions | Name | Summary | |---|---| | [map](../map.md) | [jvm]
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), [PARAMS](../map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA_1](../map.md), [PARAMS](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceModel](../-lce-model/index.md)<[DATA_2](../map.md), [PARAMS](../map.md)>
Creates a model wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md)
[jvm]
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)> [LceUseCase](../-lce-use-case/index.md)<[DATA_1](../map.md)>.[map](../map.md)(mapper: (data: [DATA_1](../map.md)) -> [DATA_2](../map.md)): [LceUseCase](../-lce-use-case/index.md)<[DATA_2](../map.md)>
Creates a use-case wrapper that converts [DATA_1](../map.md) to [DATA_2](../map.md) | | [refreshed](../refreshed.md) | [jvm]
fun <[DATA](../refreshed.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>.[refreshed](../refreshed.md)(): [LceUseCase](../-lce-use-case/index.md)<[DATA](../refreshed.md)>
Wraps use-case to refresh on each subscription | +| [update](update.md) | [jvm]
abstract fun [update](update.md)(update: [UPDATE](index.md)): Completable
Updates data on server and refreshes local data | | [withRefresh](../with-refresh.md) | [jvm]
fun <[DATA](../with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](../-lce-use-case/index.md)<[DATA](../with-refresh.md)>.[withRefresh](../with-refresh.md)(refreshStream: Observable<in [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>): Observable<[LceState](../../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](../with-refresh.md)>>
Takes the [LceUseCase.state](../-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](../with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../../rx/com.motorro.rxlcemodel.rx/-lce-model/refresh.md) property becomes invisible for the outside world | | [withUpdates](../with-updates.md) | [jvm]
fun <[DATA](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](../with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](../-lce-model/index.md)<[DATA](../with-updates.md), [PARAMS](../with-updates.md)>.[withUpdates](../with-updates.md)(serviceSet: [UpdatingServiceSet](../../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>, ioScheduler: Scheduler = Schedulers.trampoline(), logger: [Logger](../../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](index.md)<[DATA](../with-updates.md), [UPDATE](../with-updates.md), [PARAMS](../with-updates.md)>
Wraps an [LceModel](../-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](index.md) | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/flat-map-latest-flow.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/flat-map-latest-flow.md new file mode 100644 index 00000000..1368e4ee --- /dev/null +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/flat-map-latest-flow.md @@ -0,0 +1,18 @@ +//[rx](../../index.md)/[com.motorro.rxlcemodel.rx](index.md)/[flatMapLatestFlow](flat-map-latest-flow.md) + +# flatMapLatestFlow + +[jvm]\ +fun <[DATA_1](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-latest-flow.md)>>.[flatMapLatestFlow](flat-map-latest-flow.md)(mapper: (data: [DATA_1](flat-map-latest-flow.md)) -> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>>): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>> + +Maps each [DATA_1](flat-map-latest-flow.md) to flow for [DATA_2](flat-map-latest-flow.md) and combines with original state. If error occurs in [mapper](flat-map-latest-flow.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: Using original [DATA_1](flat-map-latest-flow.md) as a parameter switch to new [DATA_2](flat-map-latest-flow.md) LCE flow + +#### Parameters + +jvm + +| | | +|---|---| +| DATA_1 | Source data type | +| DATA_2 | Resulting data type | +| mapper | Data mapper | diff --git a/docs/rx/rx/com.motorro.rxlcemodel.rx/index.md b/docs/rx/rx/com.motorro.rxlcemodel.rx/index.md index 74d8a534..f2c6f207 100644 --- a/docs/rx/rx/com.motorro.rxlcemodel.rx/index.md +++ b/docs/rx/rx/com.motorro.rxlcemodel.rx/index.md @@ -14,11 +14,23 @@ | [UpdatingLceModel](-updating-lce-model/index.md) | [jvm]
interface [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](-updating-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](-updating-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-updating-lce-model/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> : [LceModel](-lce-model/index.md)<[DATA](-updating-lce-model/index.md), [PARAMS](-updating-lce-model/index.md)>
[LceModel](-lce-model/index.md) extension that can [update](-updating-lce-model/update.md) data | | [UpdatingLceModelWrapper](-updating-lce-model-wrapper/index.md) | [jvm]
class [UpdatingLceModelWrapper](-updating-lce-model-wrapper/index.md)<[DATA](-updating-lce-model-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), in [UPDATE](-updating-lce-model-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](-updating-lce-model-wrapper/index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>(upstream: [LceModel](-lce-model/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>, serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [UPDATE](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>, ioScheduler: Scheduler, logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)?) : [UpdateWrapper](-update-wrapper/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)> , [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](-updating-lce-model-wrapper/index.md), [UPDATE](-updating-lce-model-wrapper/index.md), [PARAMS](-updating-lce-model-wrapper/index.md)>
Wraps an [LceModel](-lce-model/index.md) to enable simple data updates with the [UPDATE](-updating-lce-model-wrapper/index.md) structure (say a PUT operation) rather than individual property updates (PATCH operation). Implement [UpdateWrapper](-update-wrapper/index.md) to achieve PATCH workflow | +## Properties + +| Name | Summary | +|---|---| +| [dataNoErrors](data-no-errors.md) | [jvm]
val <[DATA](data-no-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-no-errors.md)>>.[dataNoErrors](data-no-errors.md): Observable<[DATA](data-no-errors.md)>
Model's data stream with state information dropped. No error state terminates stream | +| [dataStopOnEmptyErrors](data-stop-on-empty-errors.md) | [jvm]
val <[DATA](data-stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-empty-errors.md)>>.[dataStopOnEmptyErrors](data-stop-on-empty-errors.md): Observable<[DATA](data-stop-on-empty-errors.md)>
Model's data stream with state information dropped. Will terminate on errors with empty data | +| [dataStopOnErrors](data-stop-on-errors.md) | [jvm]
val <[DATA](data-stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-errors.md)>>.[dataStopOnErrors](data-stop-on-errors.md): Observable<[DATA](data-stop-on-errors.md)>
Model's data stream with state information dropped. Will terminate on any error | +| [stopOnEmptyErrors](stop-on-empty-errors.md) | [jvm]
val <[DATA](stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>.[stopOnEmptyErrors](stop-on-empty-errors.md): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>
Model's state stream which terminates on errors with empty data | +| [stopOnErrors](stop-on-errors.md) | [jvm]
val <[DATA](stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>.[stopOnErrors](stop-on-errors.md): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>
Model's state stream which terminates on any error | +| [validData](valid-data.md) | [jvm]
val <[DATA](valid-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](valid-data.md)>>.[validData](valid-data.md): Observable<[DATA](valid-data.md)>
Model's valid data stream with state information dropped. Will terminate on any error | + ## Functions | Name | Summary | |---|---| | [errorToLce](error-to-lce.md) | [jvm]
inline fun <[T](error-to-lce.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>.[errorToLce](error-to-lce.md)(crossinline errorData: ([Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) -> [T](error-to-lce.md)? = { null }): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[T](error-to-lce.md)>>
Maps an upstream error to LceError | +| [flatMapLatestFlow](flat-map-latest-flow.md) | [jvm]
fun <[DATA_1](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-latest-flow.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-latest-flow.md)>>.[flatMapLatestFlow](flat-map-latest-flow.md)(mapper: (data: [DATA_1](flat-map-latest-flow.md)) -> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>>): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-latest-flow.md)>>
Maps each [DATA_1](flat-map-latest-flow.md) to flow for [DATA_2](flat-map-latest-flow.md) and combines with original state. If error occurs in [mapper](flat-map-latest-flow.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: Using original [DATA_1](flat-map-latest-flow.md) as a parameter switch to new [DATA_2](flat-map-latest-flow.md) LCE flow | | [flatMapSingleData](flat-map-single-data.md) | [jvm]
fun <[DATA_1](flat-map-single-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [DATA_2](flat-map-single-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_1](flat-map-single-data.md)>>.[flatMapSingleData](flat-map-single-data.md)(mapper: (data: [DATA_1](flat-map-single-data.md)) -> Single<[DATA_2](flat-map-single-data.md)>): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA_2](flat-map-single-data.md)>>
Maps each [DATA_1](flat-map-single-data.md) to single for [DATA_2](flat-map-single-data.md) and merges back to LceState. If error occurs in [mapper](flat-map-single-data.md) emits [LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md). Example: load some [DATA_2](flat-map-single-data.md) from server using original [DATA_1](flat-map-single-data.md) as a parameter. | | [getData](get-data.md) | [jvm]
fun <[DATA](get-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](get-data.md)>>.[getData](get-data.md)(terminateOnError: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](get-data.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): Observable<[DATA](get-data.md)>
Returns model's data stream dropping state information | | [map](map.md) | [jvm]
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), [PARAMS](map.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](-lce-model/index.md)<[DATA_1](map.md), [PARAMS](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceModel](-lce-model/index.md)<[DATA_2](map.md), [PARAMS](map.md)>
Creates a model wrapper that converts [DATA_1](map.md) to [DATA_2](map.md)
[jvm]
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)> [LceUseCase](-lce-use-case/index.md)<[DATA_1](map.md)>.[map](map.md)(mapper: (data: [DATA_1](map.md)) -> [DATA_2](map.md)): [LceUseCase](-lce-use-case/index.md)<[DATA_2](map.md)>
Creates a use-case wrapper that converts [DATA_1](map.md) to [DATA_2](map.md) | @@ -28,14 +40,3 @@ | [terminateOnError](terminate-on-error.md) | [jvm]
fun <[DATA](terminate-on-error.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>.[terminateOnError](terminate-on-error.md)(predicate: ([LceState.Error](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/-error/index.md)<[DATA](terminate-on-error.md)>) -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](terminate-on-error.md)>>
Terminates [LceModel.state](../../../rx/com.motorro.rxlcemodel.rx/-lce-model/state.md) stream if [predicate](terminate-on-error.md) returns true | | [withRefresh](with-refresh.md) | [jvm]
fun <[DATA](with-refresh.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceUseCase](-lce-use-case/index.md)<[DATA](with-refresh.md)>.[withRefresh](with-refresh.md)(refreshStream: Observable<in [Nothing](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-nothing/index.html)>): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](with-refresh.md)>>
Takes the [LceUseCase.state](-lce-use-case/state.md) of model that is being refreshed each time [refreshStream](with-refresh.md) emits a value Useful when you create a model as a result of mapping of some input (params for example) and the [LceModel.refresh](../../../rx/com.motorro.rxlcemodel.rx/-lce-model/refresh.md) property becomes invisible for the outside world | | [withUpdates](with-updates.md) | [jvm]
fun <[DATA](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [UPDATE](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html), [PARAMS](with-updates.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> [LceModel](-lce-model/index.md)<[DATA](with-updates.md), [PARAMS](with-updates.md)>.[withUpdates](with-updates.md)(serviceSet: [UpdatingServiceSet](../com.motorro.rxlcemodel.rx.service/-updating-service-set/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>, ioScheduler: Scheduler = Schedulers.trampoline(), logger: [Logger](../../../common/com.motorro.rxlcemodel.common/-logger/index.md)? = null): [UpdatingLceModel](-updating-lce-model/index.md)<[DATA](with-updates.md), [UPDATE](with-updates.md), [PARAMS](with-updates.md)>
Wraps an [LceModel](-lce-model/index.md) to updating delegate creating an [UpdatingLceModel](-updating-lce-model/index.md) | - -## Properties - -| Name | Summary | -|---|---| -| [dataNoErrors](data-no-errors.md) | [jvm]
val <[DATA](data-no-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-no-errors.md)>>.[dataNoErrors](data-no-errors.md): Observable<[DATA](data-no-errors.md)>
Model's data stream with state information dropped. No error state terminates stream | -| [dataStopOnEmptyErrors](data-stop-on-empty-errors.md) | [jvm]
val <[DATA](data-stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-empty-errors.md)>>.[dataStopOnEmptyErrors](data-stop-on-empty-errors.md): Observable<[DATA](data-stop-on-empty-errors.md)>
Model's data stream with state information dropped. Will terminate on errors with empty data | -| [dataStopOnErrors](data-stop-on-errors.md) | [jvm]
val <[DATA](data-stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](data-stop-on-errors.md)>>.[dataStopOnErrors](data-stop-on-errors.md): Observable<[DATA](data-stop-on-errors.md)>
Model's data stream with state information dropped. Will terminate on any error | -| [stopOnEmptyErrors](stop-on-empty-errors.md) | [jvm]
val <[DATA](stop-on-empty-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>.[stopOnEmptyErrors](stop-on-empty-errors.md): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-empty-errors.md)>>
Model's state stream which terminates on errors with empty data | -| [stopOnErrors](stop-on-errors.md) | [jvm]
val <[DATA](stop-on-errors.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>.[stopOnErrors](stop-on-errors.md): Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](stop-on-errors.md)>>
Model's state stream which terminates on any error | -| [validData](valid-data.md) | [jvm]
val <[DATA](valid-data.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Observable<[LceState](../../../lce/lce/com.motorro.rxlcemodel.lce/-lce-state/index.md)<[DATA](valid-data.md)>>.[validData](valid-data.md): Observable<[DATA](valid-data.md)>
Model's valid data stream with state information dropped. Will terminate on any error | diff --git a/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/entries.md b/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/entries.md new file mode 100644 index 00000000..7c6eb61a --- /dev/null +++ b/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/entries.md @@ -0,0 +1,10 @@ +//[utils](../../../index.md)/[com.motorro.rxlcemodel.common](../index.md)/[LogLevel](index.md)/[entries](entries.md) + +# entries + +[common]\ +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[LogLevel](index.md)> + +Returns a representation of an immutable list of all enum entries, in the order they're declared. + +This method may be used to iterate over the enum entries. diff --git a/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/index.md b/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/index.md index a9959246..442a9b37 100644 --- a/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/index.md +++ b/docs/utils/utils/com.motorro.rxlcemodel.common/-log-level/index.md @@ -15,16 +15,17 @@ Log level | [WARNING](-w-a-r-n-i-n-g/index.md) | [common]
[WARNING](-w-a-r-n-i-n-g/index.md) | | [ERROR](-e-r-r-o-r/index.md) | [common]
[ERROR](-e-r-r-o-r/index.md) | -## Functions +## Properties | 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)): [LogLevel](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)<[LogLevel](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | +| [entries](entries.md) | [common]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.html)<[LogLevel](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](-e-r-r-o-r/index.md#-372974862%2FProperties%2F-933888423) | [common]
val [name](-e-r-r-o-r/index.md#-372974862%2FProperties%2F-933888423): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | +| [ordinal](-e-r-r-o-r/index.md#-739389684%2FProperties%2F-933888423) | [common]
val [ordinal](-e-r-r-o-r/index.md#-739389684%2FProperties%2F-933888423): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | -## Properties +## Functions | Name | Summary | |---|---| -| [name](-e-r-r-o-r/index.md#-372974862%2FProperties%2F-933888423) | [common]
val [name](-e-r-r-o-r/index.md#-372974862%2FProperties%2F-933888423): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | -| [ordinal](-e-r-r-o-r/index.md#-739389684%2FProperties%2F-933888423) | [common]
val [ordinal](-e-r-r-o-r/index.md#-739389684%2FProperties%2F-933888423): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | +| [valueOf](value-of.md) | [common]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [LogLevel](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)<[LogLevel](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | 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 f78136ea..a3b301f1 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 @@ -2,8 +2,7 @@ # LceStateView -[androidJvm]\ -interface [LceStateView](index.md)<[DATA](index.md) : Any> +interface [LceStateView](index.md)<[DATA](index.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)> Load-Content-View interface. @@ -20,19 +19,14 @@ 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
Checks if error is fatal for this view | +| [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. | +| [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 | | [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, isUpdating: Boolean)
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](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. | | [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)
Displays error when there is no data to display. | +| [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. | | [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)
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](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. | | [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, [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 29486fe3..66df664f 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 +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 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 b4ea6718..6693a91a 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, isUpdating: Boolean) +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. 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 fb8770b9..f118fe5e 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) +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. 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 dba84b0c..ab2dcc80 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) +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. diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/index.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.view/index.md index 469c4f55..f1ae042b 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>
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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)>
Load-Content-View interface. | ## Functions | Name | Summary | |---|---| -| [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. | +| [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. | 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 f0abc6e5..bba8f2ea 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, [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) +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. 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 60cc594d..6a7e1453 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, message: String? = null) +constructor(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) #### 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 020312da..0042b3a6 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 @@ -2,8 +2,7 @@ # UnhandledException -[androidJvm]\ -class [UnhandledException](index.md)(cause: Throwable, message: String? = null) : [RuntimeException](https://developer.android.com/reference/kotlin/java/lang/RuntimeException.html) +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) Exception to re-throw in LCE subscription if it was not routed through Error state @@ -20,24 +19,24 @@ androidJvm | | | |---|---| -| [UnhandledException](-unhandled-exception.md) | [androidJvm]
fun [UnhandledException](-unhandled-exception.md)(cause: Throwable, message: String? = null) | +| [UnhandledException](-unhandled-exception.md) | [androidJvm]
constructor(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) | -## Functions +## Properties | Name | Summary | |---|---| -| [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<[StackTraceElement](https://developer.android.com/reference/kotlin/java/lang/StackTraceElement.html)>) | +| [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)? | -## Properties +## Functions | Name | Summary | |---|---| -| [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? | +| [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) | +| [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)>) | 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 c26507c1..c647f3bb 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, 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 | +| [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 | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-base-lce-model.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-base-lce-model.md index cd9dac8b..b92d9631 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-base-lce-model.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-base-lce-model.md @@ -3,4 +3,4 @@ # BaseLceModel [androidJvm]\ -fun [BaseLceModel](-base-lce-model.md)() +constructor() 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 2af429a3..73e47ede 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> [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](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 @@ -17,7 +17,7 @@ androidJvm | refresh | Refresh operation | [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](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)> 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 6dc26a30..073649df 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> [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 | +| [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 | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/-impl.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/-impl.md index 89dcb796..febe3120 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/-impl.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-lce-model/-impl/-impl.md @@ -3,4 +3,4 @@ # Impl [androidJvm]\ -fun [Impl](-impl.md)() +constructor() 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 a2d4dd3b..53fb3d2f 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 @@ -2,16 +2,29 @@ # Impl -[androidJvm]\ -abstract class [Impl](index.md)<[DATA](index.md) : Any> : [BaseLceModel](../index.md)<[DATA](index.md)> +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)> Basic ViewModel with LceModel inside +#### Inheritors + +| | +|---| +| [WithUpdates](../-with-updates/index.md) | + ## Constructors | | | |---|---| -| [Impl](-impl.md) | [androidJvm]
fun [Impl](-impl.md)() | +| [Impl](-impl.md) | [androidJvm]
constructor() | + +## Properties + +| 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 | +| [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 | ## Functions @@ -19,22 +32,8 @@ 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)
Default action on critical 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 | | [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 | | [restart](restart.md) | [androidJvm]
open override fun [restart](restart.md)()
Retries data subscription from scratch | - -## Properties - -| Name | Summary | -|---|---| -| [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 - -| Name | -|---| -| [WithUpdates](../-with-updates/index.md) | 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 aeec5c7a..38ee9802 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> [WithUpdates](-with-updates.md)(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) +constructor(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 dc6bb1fd..49661b08 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 @@ -2,8 +2,7 @@ # WithUpdates -[androidJvm]\ -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)> +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)> View model with operations that mix with commonMain state @@ -19,7 +18,15 @@ androidJvm | | | |---|---| -| [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)>) | +| [WithUpdates](-with-updates.md) | [androidJvm]
constructor(dataUseCase: [LceUseCase](../../../../../rx/rx/com.motorro.rxlcemodel.rx/-lce-use-case/index.md)<[DATA](index.md)>) | + +## Properties + +| 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 | +| [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 | ## Functions @@ -27,16 +34,8 @@ 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)
Default action on critical 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 | | [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 | | [restart](../-impl/restart.md) | [androidJvm]
open override fun [restart](../-impl/restart.md)()
Retries data subscription from scratch | - -## Properties - -| Name | Summary | -|---|---| -| [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 db2965d6..09053ec2 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) +open fun [dismissError](dismiss-error.md)(error: [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.html)) 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 0c906d14..6f90677d 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 @@ -2,24 +2,37 @@ # BaseLceModel -[androidJvm]\ -abstract class [BaseLceModel](index.md)<[DATA](index.md) : Any> : [BaseViewModel](../-base-view-model/index.md) +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) Base model with [state](state.md) and [refresh](refresh.md) +#### Inheritors + +| | +|---| +| [Impl](-impl/index.md) | + ## Constructors | | | |---|---| -| [BaseLceModel](-base-lce-model.md) | [androidJvm]
fun [BaseLceModel](-base-lce-model.md)() | +| [BaseLceModel](-base-lce-model.md) | [androidJvm]
constructor() | ## Types | 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> : [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 | +| [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 | + +## Properties + +| 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 | +| [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 | ## Functions @@ -27,22 +40,8 @@ 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)
Default action on critical 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 | | [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 | | [restart](restart.md) | [androidJvm]
abstract fun [restart](restart.md)()
Retries data subscription from scratch | - -## Properties - -| Name | Summary | -|---|---| -| [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 - -| Name | -|---| -| [Impl](-impl/index.md) | diff --git a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/-base-view-model.md b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/-base-view-model.md index a28555b0..69be9ea5 100644 --- a/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/-base-view-model.md +++ b/docs/viewmodel/viewmodel/com.motorro.rxlcemodel.viewmodel/-base-view-model/-base-view-model.md @@ -3,4 +3,4 @@ # BaseViewModel [androidJvm]\ -fun [BaseViewModel](-base-view-model.md)() +constructor() 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 adf98876..f108a6b4 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 = false +var [cleared](cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) 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 608dad43..a8814f71 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 @@ -2,34 +2,33 @@ # BaseViewModel -[androidJvm]\ abstract class [BaseViewModel](index.md) : [ViewModel](https://developer.android.com/reference/kotlin/androidx/lifecycle/ViewModel.html) Base view model with [initialize](initialize.md) and [doClear](do-clear.md) methods +#### Inheritors + +| | +|---| +| [BaseLceModel](../-base-lce-model/index.md) | + ## Constructors | | | |---|---| -| [BaseViewModel](-base-view-model.md) | [androidJvm]
fun [BaseViewModel](-base-view-model.md)() | +| [BaseViewModel](-base-view-model.md) | [androidJvm]
constructor() | -## Functions +## Properties | Name | Summary | |---|---| -| [addCloseable](index.md#264516373%2FFunctions%2F1456247564) | [androidJvm]
open fun [addCloseable](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)) | -| [doClear](do-clear.md) | [androidJvm]
abstract fun [doClear](do-clear.md)()
Disposes active operations when model is destroyed | -| [initialize](initialize.md) | [androidJvm]
fun [initialize](initialize.md)()
Call this function to initialize a new model and start receiving events | +| [cleared](cleared.md) | [androidJvm]
var [cleared](cleared.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is model cleared | +| [initialized](initialized.md) | [androidJvm]
var [initialized](initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
Is model initialized | -## Properties +## Functions | Name | Summary | |---|---| -| [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 - -| Name | -|---| -| [BaseLceModel](../-base-lce-model/index.md) | +| [addCloseable](index.md#264516373%2FFunctions%2F1456247564) | [androidJvm]
open fun [addCloseable](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)) | +| [doClear](do-clear.md) | [androidJvm]
abstract fun [doClear](do-clear.md)()
Disposes active operations when model is destroyed | +| [initialize](initialize.md) | [androidJvm]
fun [initialize](initialize.md)()
Call this function to initialize a new model and start receiving events | 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 1e0807cb..ecbd9bce 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 = false +var [initialized](initialized.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) 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 c47cb2aa..309abd39 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> : [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](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) | | [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 |