ViewModelProvider
open class ViewModelProvider
kotlin.Any | |
↳ | androidx.lifecycle.ViewModelProvider |
An utility class that provides ViewModels
for a scope.
Default ViewModelProvider
for an Activity
or a Fragment
can be obtained by passing it to ViewModelProvider#ViewModelProvider(ViewModelStoreOwner)
.
Summary
Nested classes | |
---|---|
open |
|
abstract |
Implementations of |
open |
Simple factory, which calls empty constructor on the give class. |
Public constructors | |
---|---|
<init>(@NonNull owner: ViewModelStoreOwner) Creates |
|
<init>(@NonNull owner: ViewModelStoreOwner, @NonNull factory: ViewModelProvider.Factory) Creates |
|
<init>(@NonNull store: ViewModelStore, @NonNull factory: ViewModelProvider.Factory) Creates |
Public methods | |
---|---|
open T |
Returns an existing ViewModel or creates a new one in the scope (usually, a fragment or an activity), associated with this |
open T |
Returns an existing ViewModel or creates a new one in the scope (usually, a fragment or an activity), associated with this |
Extension functions | ||
---|---|---|
From androidx.lifecycle
|
Public constructors
<init>
ViewModelProvider(@NonNull owner: ViewModelStoreOwner)
Creates ViewModelProvider
. This will create ViewModels
and retain them in a store of the given ViewModelStoreOwner
.
This method will use the default factory
if the owner implements HasDefaultViewModelProviderFactory
. Otherwise, a NewInstanceFactory
will be used.
<init>
ViewModelProvider(
@NonNull owner: ViewModelStoreOwner,
@NonNull factory: ViewModelProvider.Factory)
Creates ViewModelProvider
, which will create ViewModels
via the given Factory
and retain them in a store of the given ViewModelStoreOwner
.
Parameters | |
---|---|
owner |
ViewModelStoreOwner: a ViewModelStoreOwner whose ViewModelStore will be used to retain ViewModels |
factory |
ViewModelProvider.Factory: a Factory which will be used to instantiate new ViewModels |
<init>
ViewModelProvider(
@NonNull store: ViewModelStore,
@NonNull factory: ViewModelProvider.Factory)
Creates ViewModelProvider
, which will create ViewModels
via the given Factory
and retain them in the given store
.
Parameters | |
---|---|
store |
ViewModelStore: ViewModelStore where ViewModels will be stored. |
factory |
ViewModelProvider.Factory: factory a Factory which will be used to instantiate new ViewModels |
Public methods
get
@NonNull @MainThread open fun <T : ViewModel!> get(@NonNull modelClass: Class<T>): T
Returns an existing ViewModel or creates a new one in the scope (usually, a fragment or an activity), associated with this ViewModelProvider
.
The created ViewModel is associated with the given scope and will be retained as long as the scope is alive (e.g. if it is an activity, until it is finished or process is killed).
Parameters | |
---|---|
modelClass |
Class<T>: The class of the ViewModel to create an instance of it if it is not present. |
<T> |
The type parameter for the ViewModel. |
Return | |
---|---|
T |
A ViewModel that is an instance of the given type T . |
get
@NonNull @MainThread open fun <T : ViewModel!>