Home | History | Annotate | Download | only in lifecycle
      1 /*
      2  * Copyright (C) 2017 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 
     17 package androidx.lifecycle;
     18 
     19 import androidx.annotation.NonNull;
     20 
     21 /**
     22  * A scope that owns {@link ViewModelStore}.
     23  * <p>
     24  * A responsibility of an implementation of this interface is to retain owned ViewModelStore
     25  * during the configuration changes and call {@link ViewModelStore#clear()}, when this scope is
     26  * going to be destroyed.
     27  */
     28 @SuppressWarnings("WeakerAccess")
     29 public interface ViewModelStoreOwner {
     30     /**
     31      * Returns owned {@link ViewModelStore}
     32      *
     33      * @return a {@code ViewModelStore}
     34      */
     35     @NonNull
     36     ViewModelStore getViewModelStore();
     37 }
     38