Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
Fixes: #47
  • Loading branch information
Nikolay Kochetkov committed May 8, 2023
1 parent 32025c0 commit d6c0d45
Showing 130 changed files with 306 additions and 279 deletions.
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# createSnapshot

[common]\
abstract fun [createSnapshot](create-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md)
abstract fun [createSnapshot](create-snapshot.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md)

Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation.

@@ -19,4 +19,4 @@ common

| | |
|---|---|
| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if serialized can't be deserialized |
| IllegalArgumentException | if serialized can't be deserialized |
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# create

[common]\
abstract fun [create](create.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md)
abstract fun [create](create.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md)

Creates entity cache-control

@@ -19,4 +19,4 @@ common

| | |
|---|---|
| [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html) | if serialized can't be deserialized |
| IllegalArgumentException | if serialized can't be deserialized |
Original file line number Diff line number Diff line change
@@ -11,8 +11,8 @@ Cache-control [EntityValidator](../-entity-validator/index.md) factory for opera

| Name | Summary |
|---|---|
| [create](create.md) | [common]<br>abstract fun [create](create.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)? = null): [EntityValidator](../-entity-validator/index.md)<br>Creates entity cache-control |
| [createSnapshot](create-snapshot.md) | [common]<br>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)<br>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]<br>abstract fun [create](create.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md)<br>Creates entity cache-control |
| [createSnapshot](create-snapshot.md) | [common]<br>abstract fun [createSnapshot](create-snapshot.md)(serialized: String? = null): [EntityValidator](../-entity-validator/index.md)<br>Creates a snapshot of entity cache-control.The [EntityValidator.isValid](../-entity-validator/is-valid.md) evaluated at the time of creation. |

## Inheritors

Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserialize

[common]\
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?

Deserializes validator from string if string is recognized

Original file line number Diff line number Diff line change
@@ -11,5 +11,5 @@ Deserializes validator from string

| Name | Summary |
|---|---|
| [deserialize](deserialize.md) | [common]<br>open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]<br>open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time |
| [deserialize](deserialize.md) | [common]<br>open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]<br>open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time |
Original file line number Diff line number Diff line change
@@ -18,5 +18,5 @@ Entity that is always valid
| Name | Summary |
|---|---|
| [createSnapshot](../create-snapshot.md) | [common]<br>open fun [createSnapshot](../create-snapshot.md)(): [EntityValidator](../index.md)<br>Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value |
| [isValid](is-valid.md) | [common]<br>open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>If true cached entity is valid. |
| [serialize](serialize.md) | [common]<br>open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>A way to serialize entity |
| [isValid](is-valid.md) | [common]<br>open override fun [isValid](is-valid.md)(): Boolean<br>If true cached entity is valid. |
| [serialize](serialize.md) | [common]<br>open override fun [serialize](serialize.md)(): String<br>A way to serialize entity |
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# isValid

[common]\
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
open override fun [isValid](is-valid.md)(): Boolean

If true cached entity is valid.
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# serialize

[common]\
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
open override fun [serialize](serialize.md)(): String

A way to serialize entity
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserializeSnapshot

[common]\
open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)?
open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../index.md)?

Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../is-valid.md) with time

Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserialize

[common]\
abstract fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)?
abstract fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../index.md)?

Deserializes validator from string if string is recognized

Original file line number Diff line number Diff line change
@@ -11,8 +11,8 @@ Deserializes validator from string

| Name | Summary |
|---|---|
| [deserialize](deserialize.md) | [common]<br>abstract fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](deserialize-snapshot.md) | [common]<br>open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../is-valid.md) with time |
| [deserialize](deserialize.md) | [common]<br>abstract fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](deserialize-snapshot.md) | [common]<br>open fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../is-valid.md) with time |

## Inheritors

Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# createSnapshot

[common]\
fun [createSnapshot](create-snapshot.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md)
fun [createSnapshot](create-snapshot.md)(ttl: Long, clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md)

Creates a snapshot that may be serialized and deserialized back to dynamic [Lifespan](../index.md)

Original file line number Diff line number Diff line change
@@ -9,4 +9,4 @@ object [Companion](index.md)

| Name | Summary |
|---|---|
| [createSnapshot](create-snapshot.md) | [common]<br>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)<br>Creates a snapshot that may be serialized and deserialized back to dynamic [Lifespan](../index.md) |
| [createSnapshot](create-snapshot.md) | [common]<br>fun [createSnapshot](create-snapshot.md)(ttl: Long, clock: [Clock](../../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM): [EntityValidator.Lifespan](../index.md)<br>Creates a snapshot that may be serialized and deserialized back to dynamic [Lifespan](../index.md) |
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserializeSnapshot

[common]\
open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?

Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time

Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserialize

[common]\
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?

Deserializes validator from string if string is recognized

Original file line number Diff line number Diff line change
@@ -23,5 +23,5 @@ Deserializes validator from string

| Name | Summary |
|---|---|
| [deserialize](deserialize.md) | [common]<br>open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](deserialize-snapshot.md) | [common]<br>open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time |
| [deserialize](deserialize.md) | [common]<br>open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](deserialize-snapshot.md) | [common]<br>open override fun [deserializeSnapshot](deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time |
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# Lifespan

[common]\
fun [Lifespan](-lifespan.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM)
fun [Lifespan](-lifespan.md)(ttl: Long, clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM)

#### Parameters

Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# equals

[common]\
open operator override fun [equals](equals.md)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
open operator override fun [equals](equals.md)(other: Any?): Boolean

As soon as we should provide [EntityValidator](../index.md) interface we compare only the commonMain property - validity - not the internal state
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# hashCode

[common]\
open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)
open override fun [hashCode](hash-code.md)(): Int

As soon as we should provide [EntityValidator](../index.md) interface we calculate the commonMain property - validity - not the internal state
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ common

| | |
|---|---|
| [Lifespan](-lifespan.md) | [common]<br>fun [Lifespan](-lifespan.md)(ttl: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html), clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) |
| [Lifespan](-lifespan.md) | [common]<br>fun [Lifespan](-lifespan.md)(ttl: Long, clock: [Clock](../../../../../common/com.motorro.rxlcemodel.common/-clock/index.md) = Clock.SYSTEM) |

## Types

@@ -35,8 +35,8 @@ common
| Name | Summary |
|---|---|
| [createSnapshot](create-snapshot.md) | [common]<br>open override fun [createSnapshot](create-snapshot.md)(): [EntityValidator](../index.md)<br>Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value |
| [equals](equals.md) | [common]<br>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)<br>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]<br>open override fun [hashCode](hash-code.md)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)<br>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]<br>open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>If true cached entity is valid. |
| [serialize](serialize.md) | [common]<br>open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>A way to serialize entity |
| [toString](to-string.md) | [common]<br>open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>Display string |
| [equals](equals.md) | [common]<br>open operator override fun [equals](equals.md)(other: Any?): Boolean<br>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]<br>open override fun [hashCode](hash-code.md)(): Int<br>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]<br>open override fun [isValid](is-valid.md)(): Boolean<br>If true cached entity is valid. |
| [serialize](serialize.md) | [common]<br>open override fun [serialize](serialize.md)(): String<br>A way to serialize entity |
| [toString](to-string.md) | [common]<br>open override fun [toString](to-string.md)(): String<br>Display string |
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# isValid

[common]\
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
open override fun [isValid](is-valid.md)(): Boolean

If true cached entity is valid.
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# serialize

[common]\
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
open override fun [serialize](serialize.md)(): String

A way to serialize entity
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# toString

[common]\
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
open override fun [toString](to-string.md)(): String

Display string
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserialize

[common]\
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?

Deserializes validator from string if string is recognized

Original file line number Diff line number Diff line change
@@ -11,5 +11,5 @@ Deserializes validator from string

| Name | Summary |
|---|---|
| [deserialize](deserialize.md) | [common]<br>open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]<br>open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time |
| [deserialize](deserialize.md) | [common]<br>open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?<br>Deserializes validator from string if string is recognized |
| [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md) | [common]<br>open fun [deserializeSnapshot](../../-deserializer/deserialize-snapshot.md)(serialized: String): [EntityValidator](../../index.md)?<br>Deserializes an immutable snapshot of validator that does not change [EntityValidator.isValid](../../is-valid.md) with time |
Original file line number Diff line number Diff line change
@@ -18,5 +18,5 @@ Entity that is never valid
| Name | Summary |
|---|---|
| [createSnapshot](../create-snapshot.md) | [common]<br>open fun [createSnapshot](../create-snapshot.md)(): [EntityValidator](../index.md)<br>Crates a snapshot of validator preserving it's current [EntityValidator.isValid](../is-valid.md) value |
| [isValid](is-valid.md) | [common]<br>open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)<br>If true cached entity is valid. |
| [serialize](serialize.md) | [common]<br>open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)<br>A way to serialize entity |
| [isValid](is-valid.md) | [common]<br>open override fun [isValid](is-valid.md)(): Boolean<br>If true cached entity is valid. |
| [serialize](serialize.md) | [common]<br>open override fun [serialize](serialize.md)(): String<br>A way to serialize entity |
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# isValid

[common]\
open override fun [isValid](is-valid.md)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)
open override fun [isValid](is-valid.md)(): Boolean

If true cached entity is valid.
Original file line number Diff line number Diff line change
@@ -3,6 +3,6 @@
# serialize

[common]\
open override fun [serialize](serialize.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
open override fun [serialize](serialize.md)(): String

A way to serialize entity
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
# deserialize

[common]\
open override fun [deserialize](deserialize.md)(serialized: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)): [EntityValidator](../../index.md)?
open override fun [deserialize](deserialize.md)(serialized: String): [EntityValidator](../../index.md)?

Deserializes validator from string if string is recognized

Loading

0 comments on commit d6c0d45

Please sign in to comment.