Skip to content

Instantly share code, notes, and snippets.

@JoseAlcerreca
Last active February 28, 2021 00:07
Show Gist options
  • Star 17 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save JoseAlcerreca/4b66f9953d50b483d80e6b9ad7172685 to your computer and use it in GitHub Desktop.
Save JoseAlcerreca/4b66f9953d50b483d80e6b9ad7172685 to your computer and use it in GitHub Desktop.
An Observable ViewModel for Data Binding and Architecture Components
/*
* Copyright (C) 2018 The Android Open Source Project
*
* 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.
*/
import android.arch.lifecycle.ViewModel
import android.databinding.Bindable
import android.databinding.Observable
import android.databinding.PropertyChangeRegistry
/**
* An [Observable] [ViewModel] for Data Binding.
*/
open class ObservableViewModel : ViewModel(), Observable {
private val callbacks: PropertyChangeRegistry by lazy { PropertyChangeRegistry() }
override fun addOnPropertyChangedCallback(callback: Observable.OnPropertyChangedCallback) {
callbacks.add(callback)
}
override fun removeOnPropertyChangedCallback(callback: Observable.OnPropertyChangedCallback) {
callbacks.remove(callback)
}
/**
* Notifies listeners that all properties of this instance have changed.
*/
fun notifyChange() {
callbacks.notifyCallbacks(this, 0, null)
}
/**
* Notifies listeners that a specific property has changed. The getter for the property
* that changes should be marked with [Bindable] to generate a field in
* `BR` to be used as `fieldId`.
*
* @param fieldId The generated BR id for the Bindable field.
*/
fun notifyPropertyChanged(fieldId: Int) {
callbacks.notifyCallbacks(this, fieldId, null)
}
}
@anandwana001
Copy link

What are the advantages of using ObservableField over LiveData? LiveData is lifecycle aware and for ObservableField we have to manually handle Lifecycle!!

@florianwalther-private
Copy link

@anandwana001 You don't have to handle lifecycle for Observable Fields, the Data Binding library takes care of not updating views that are not are currently not displayed on the screen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment