Created
April 26, 2018 10:25
-
-
Save JoseAlcerreca/5b661f1800e1e654f07cc54fe87441af to your computer and use it in GitHub Desktop.
An event wrapper for data that is exposed via a LiveData that represents an event.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Used as a wrapper for data that is exposed via a LiveData that represents an event. | |
*/ | |
open class Event<out T>(private val content: T) { | |
var hasBeenHandled = false | |
private set // Allow external read but not write | |
/** | |
* Returns the content and prevents its use again. | |
*/ | |
fun getContentIfNotHandled(): T? { | |
return if (hasBeenHandled) { | |
null | |
} else { | |
hasBeenHandled = true | |
content | |
} | |
} | |
/** | |
* Returns the content, even if it's already been handled. | |
*/ | |
fun peekContent(): T = content | |
} | |
In Kotlin, passing events to a single observer is also possible with Channel.receiveAsFlow()
and lifecycle-aware collector. Advantages:
- Can queue multiple events while observer is inactive (configuration change, app in background, fragment in back stack), with customizable buffer size and
onBufferOverflow
strategy - Optionally supports
null
values - No need to wrap data in
Event
That looks nearly like my latest solution. However, I don't use a special EventObserver, since a Kotlin extension function can do the job:
class Event<out T>(private val content: T) { private val consumedScopes = HashSet<String>()
Adding more syntactic sugar to choirwire's contribution
class Event<out T>(private val content: T) {
private val consumedScopes by lazy { HashSet<String>() }
fun isConsumed(scope: String = "") = scope in consumedScopes
@MainThread
fun consume(scope: String = ""): T? {
return content.takeIf { !isConsumed(scope) }?.also { consumedScopes.add(scope) }
}
fun peek(): T = content
}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is so concise.