1 /*
2  * Copyright 2019 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package androidx.lifecycle
17 
18 import androidx.lifecycle.viewmodel.CreationExtras
19 
20 /**
21  * Interface that marks a [ViewModelStoreOwner] as having a default [ViewModelProvider.Factory] for
22  * use with [ViewModelProvider].
23  */
24 public interface HasDefaultViewModelProviderFactory {
25     /**
26      * Returns the default [ViewModelProvider.Factory] that should be used when no custom `Factory`
27      * is provided to the [ViewModelProvider] constructors.
28      */
29     public val defaultViewModelProviderFactory: ViewModelProvider.Factory
30 
31     /**
32      * Returns the default [CreationExtras] that should be passed into
33      * [ViewModelProvider.Factory.create] when no overriding [CreationExtras] were passed to the
34      * [ViewModelProvider] constructors.
35      */
36     public val defaultViewModelCreationExtras: CreationExtras
37         get() = CreationExtras.Empty
38 }
39