1 /*
2  * Copyright 2021 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.appsearch.localstorage;
18 
19 import androidx.annotation.RestrictTo;
20 
21 import com.google.android.icing.proto.GetOptimizeInfoResultProto;
22 
23 import org.jspecify.annotations.NonNull;
24 
25 /**
26  * An interface class for implementing a strategy to determine when to trigger
27  * {@link AppSearchImpl#optimize()}.
28  * @exportToFramework:hide
29  */
30 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
31 public interface OptimizeStrategy {
32 
33     /**
34      * Determines whether {@link AppSearchImpl#optimize()} need to be triggered to release garbage
35      * resources in AppSearch base on the given information.
36      *
37      * @param optimizeInfo The proto object indicates the number of garbage resources in AppSearch.
38      * @return {@code true} if {@link AppSearchImpl#optimize()} need to be triggered.
39      */
shouldOptimize(@onNull GetOptimizeInfoResultProto optimizeInfo)40     boolean shouldOptimize(@NonNull GetOptimizeInfoResultProto optimizeInfo);
41 }
42