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.os.LocaleList;
21 import android.os.UserHandle;
22 
23 import androidx.annotation.Nullable;
24 
25 import com.android.launcher3.icons.BitmapInfo;
26 
27 public interface CachingLogic<T> {
28 
getComponent(T object)29     ComponentName getComponent(T object);
30 
getUser(T object)31     UserHandle getUser(T object);
32 
getLabel(T object)33     CharSequence getLabel(T object);
34 
loadIcon(Context context, T object, BitmapInfo target)35     void loadIcon(Context context, T object, BitmapInfo target);
36 
37     /**
38      * Provides a option list of keywords to associate with this object
39      */
40     @Nullable
getKeywords(T object, LocaleList localeList)41     default String getKeywords(T object, LocaleList localeList) {
42         return null;
43     }
44 
45     /**
46      * Returns true the object should be added to mem cache; otherwise returns false.
47      */
addToMemCache()48     default boolean addToMemCache() {
49         return true;
50     }
51 }
52