/
Disposable.kt
89 lines (77 loc) · 2.53 KB
/
Disposable.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* Copyright (C) 2022 panpf <panpfpanpf@outlook.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.github.panpf.sketch.request
import android.view.View
import androidx.lifecycle.DefaultLifecycleObserver
import com.github.panpf.sketch.Sketch
import com.github.panpf.sketch.request.internal.requestManager
import kotlinx.coroutines.Deferred
import java.lang.ref.WeakReference
/**
* Represents the work of an *Request that has been executed by an [Sketch].
*/
interface Disposable<T> {
/**
* The most recent image request job.
* This field is **not immutable** and can change if the request is replayed.
*/
val job: Deferred<T>
/**
* Returns 'true' if this disposable's work is complete or cancelling.
*/
val isDisposed: Boolean
/**
* Cancels this disposable's work and releases any held resources.
*/
fun dispose()
}
/**
* A disposable for one-shot image requests.
*/
class OneShotDisposable<T>(
override val job: Deferred<T>
) : Disposable<T> {
override val isDisposed: Boolean
get() = !job.isActive
override fun dispose() {
if (!isDisposed) {
job.cancel()
}
}
}
/**
* A disposable for requests that are attached to a [View].
*
* [com.github.panpf.sketch.target.ViewDisplayTarget] requests are automatically cancelled in when the view is detached
* and are restarted when the view is attached.
*
* [isDisposed] only returns 'true' when this disposable's request is cleared (due to
* [DefaultLifecycleObserver.onDestroy]) or replaced by a new request attached to the view.
*/
class ViewTargetDisposable(
private val viewReference: WeakReference<View>,
@Volatile override var job: Deferred<DisplayResult>
) : Disposable<DisplayResult> {
private val view: View?
get() = viewReference.get()
override val isDisposed: Boolean
get() = view?.requestManager?.isDisposed(this) != false
override fun dispose() {
if (!isDisposed) {
view?.requestManager?.dispose()
}
}
}