Skip to content

608: Update TypedWorker kdoc #609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 13, 2021
Merged

608: Update TypedWorker kdoc #609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions workflow-core/src/main/java/com/squareup/workflow1/Worker.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,16 @@ public interface Worker<out OutputT> {
*
* At the end of every render pass, the set of [Worker]s that were requested by the workflow are
* compared to the set from the last render pass using this method. Workers are compared by their
* _declared_ type. Equivalent workers are allowed to keep running. New workers are started ([run]
* is called and the returned [Flow] is collected). Old workers are cancelled by cancelling their
* collecting coroutines. Workers for which [doesSameWorkAs] returns false will also be restarted.
* _declared_ [KType] - including generics. Equivalent workers are allowed to keep running.
* New workers are started ([run] is called and the returned [Flow] is collected). Old workers are
* cancelled by cancelling their collecting coroutines. Workers for which [doesSameWorkAs] returns
* false will also be restarted.
*
* Implementations of this method should not be based on object identity. For example, a [Worker]
* that performs a network request might check that two workers are requests to the same endpoint
* and have the same request data.
* Implementations of this method should not be based on object identity. Nor do they need to be
* based on anything including in the [KType] - such as generics - as those will already be
* compared by the Workflow Runtime, see [WorkerWorkflow].
* For example, a [Worker] that performs a network request might check that two workers are
* requests to the same endpoint and have the same request data.
*
* Most implementations of this method should compare constructor parameters.
*
Expand Down Expand Up @@ -314,6 +317,9 @@ public fun <T, R> Worker<T>.transform(
/**
* A generic [Worker] implementation that defines equivalent workers as those having equivalent
* [outputType]s. This is used by all the [Worker] builder functions.
*
* Note: We do not override the [doesSameWorkAs] definition here because the [outputType] [KType]
* is already compared as part of the [KType] of the class itself in the Workflow runtime.
*/
@PublishedApi
internal class TypedWorker<OutputT>(
Expand Down