1 /*
2  * Copyright (C) 2018 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 com.android.launcher3.icons.cache;
17 
18 import android.content.ComponentName;
19 import android.content.Context;
20 import android.content.pm.PackageInfo;
21 import android.os.LocaleList;
22 import android.os.UserHandle;
23 
24 import androidx.annotation.NonNull;
25 import androidx.annotation.Nullable;
26 
27 import com.android.launcher3.icons.BitmapInfo;
28 
29 public interface CachingLogic<T> {
30 
getComponent(T object)31     ComponentName getComponent(T object);
32 
getUser(T object)33     UserHandle getUser(T object);
34 
getLabel(T object)35     CharSequence getLabel(T object);
36 
getDescription(T object, CharSequence fallback)37     default CharSequence getDescription(T object, CharSequence fallback) {
38         return fallback;
39     }
40 
41     @NonNull
loadIcon(Context context, T object)42     BitmapInfo loadIcon(Context context, T object);
43 
44     /**
45      * Provides a option list of keywords to associate with this object
46      */
47     @Nullable
getKeywords(T object, LocaleList localeList)48     default String getKeywords(T object, LocaleList localeList) {
49         return null;
50     }
51 
52     /**
53      * Returns the timestamp the entry was last updated in cache.
54      */
getLastUpdatedTime(T object, PackageInfo info)55     default long getLastUpdatedTime(T object, PackageInfo info) {
56         return info.lastUpdateTime;
57     }
58 
59     /**
60      * Returns true the object should be added to mem cache; otherwise returns false.
61      */
addToMemCache()62     default boolean addToMemCache() {
63         return true;
64     }
65 }
66