• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 
31     @NonNull
getComponent(@onNull final T object)32     ComponentName getComponent(@NonNull final T object);
33 
34     @NonNull
getUser(@onNull final T object)35     UserHandle getUser(@NonNull final T object);
36 
37     @NonNull
getLabel(@onNull final T object)38     CharSequence getLabel(@NonNull final T object);
39 
40     @NonNull
getDescription(@onNull final T object, @NonNull final CharSequence fallback)41     default CharSequence getDescription(@NonNull final T object,
42             @NonNull final CharSequence fallback) {
43         return fallback;
44     }
45 
46     @NonNull
loadIcon(@onNull final Context context, @NonNull final T object)47     BitmapInfo loadIcon(@NonNull final Context context, @NonNull final T object);
48 
49     /**
50      * Provides a option list of keywords to associate with this object
51      */
52     @Nullable
getKeywords(@onNull final T object, @NonNull final LocaleList localeList)53     default String getKeywords(@NonNull final T object, @NonNull final LocaleList localeList) {
54         return null;
55     }
56 
57     /**
58      * Returns the timestamp the entry was last updated in cache.
59      */
getLastUpdatedTime(@ullable final T object, @NonNull final PackageInfo info)60     default long getLastUpdatedTime(@Nullable final T object, @NonNull final PackageInfo info) {
61         return info.lastUpdateTime;
62     }
63 
64     /**
65      * Returns true the object should be added to mem cache; otherwise returns false.
66      */
addToMemCache()67     default boolean addToMemCache() {
68         return true;
69     }
70 }
71