-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SingleLiveEvent wasn't unique if used with `observeForever`. UniqueLiveEvent provides a unique notification among both `observe` and `observeForever`. Unfortunately I cannot simply update SingleLiveEvent because, right now, some SingleLiveEvent are used inside one or more MediatorLiveData which would break those usages
- Loading branch information
Showing
2 changed files
with
48 additions
and
4 deletions.
There are no files selected for viewing
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
39 changes: 39 additions & 0 deletions
39
src/main/java/com/infomaniak/lib/core/utils/UniqueLiveEvent.kt
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
/* | ||
* Infomaniak Core - Android | ||
* Copyright (C) 2024 Infomaniak Network SA | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU General Public License as published by | ||
* the Free Software Foundation, either version 3 of the License, or | ||
* (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
package com.infomaniak.lib.core.utils | ||
|
||
import android.util.Log | ||
import androidx.lifecycle.MediatorLiveData | ||
import androidx.lifecycle.Observer | ||
|
||
/** | ||
* "Now with 100% more uniqueness to it!". | ||
* | ||
* [UniqueLiveEvent] single notification is now shared between [observe] and [observeForever]. | ||
* | ||
* This has for a side effect that [UniqueLiveEvent] will only trigger once even if used with [MediatorLiveData] which is not | ||
* backward compatible with [SingleLiveEvent]. | ||
*/ | ||
class UniqueLiveEvent<T> : SingleLiveEvent<T>() { | ||
override fun observeForever(observer: Observer<in T>) { | ||
if (hasActiveObservers()) Log.w(TAG, MULTIPLE_OBSERVER_WARNING) | ||
|
||
// Observe the internal MutableLiveData | ||
super.observeForever { t -> if (pending.compareAndSet(true, false)) observer.onChanged(t) } | ||
} | ||
} |