1 /* 2 * Copyright (C) 2022 The Dagger Authors. 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 dagger.hilt.android.lifecycle; 18 19 import androidx.annotation.MainThread; 20 import androidx.annotation.NonNull; 21 22 /** 23 * A class for registered listeners on a retained lifecycle (generally backed up by a ViewModel). 24 */ 25 public interface RetainedLifecycle { 26 27 /** 28 * Adds a new {@link OnClearedListener} for receiving a callback when the lifecycle is cleared. 29 * 30 * @param listener The listener that should be added. 31 */ 32 @MainThread addOnClearedListener(@onNull OnClearedListener listener)33 void addOnClearedListener(@NonNull OnClearedListener listener); 34 35 /** 36 * Removes a {@link OnClearedListener} previously added via {@link 37 * #addOnClearedListener(OnClearedListener)}. 38 * 39 * @param listener The listener that should be removed. 40 */ 41 @MainThread removeOnClearedListener(@onNull OnClearedListener listener)42 void removeOnClearedListener(@NonNull OnClearedListener listener); 43 44 /** Listener for when the retained lifecycle is cleared. */ 45 interface OnClearedListener { onCleared()46 void onCleared(); 47 } 48 } 49