summaryrefslogtreecommitdiffstats
path: root/src/com/android/launcher3/badge/BadgeInfo.java
blob: 98d2277d0dc73e3729c7ba9240b56ef9a57ff9f2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.launcher3.badge;

import com.android.launcher3.util.PackageUserKey;

import java.util.HashSet;
import java.util.Set;

/**
 * Contains data to be used in an icon badge.
 */
public class BadgeInfo {

    /** Used to link this BadgeInfo to icons on the workspace and all apps */
    private PackageUserKey mPackageUserKey;
    /**
     * The keys of the notifications that this badge represents. These keys can later be
     * used to retrieve {@link com.android.launcher3.badging.NotificationInfo}'s.
     */
    private Set<String> mNotificationKeys;

    public BadgeInfo(PackageUserKey packageUserKey) {
        mPackageUserKey = packageUserKey;
        mNotificationKeys = new HashSet<>();
    }

    /**
     * Returns whether the notification was added (false if it already existed).
     */
    public boolean addNotificationKey(String notificationKey) {
        return mNotificationKeys.add(notificationKey);
    }

    /**
     * Returns whether the notification was removed (false if it didn't exist).
     */
    public boolean removeNotificationKey(String notificationKey) {
        return mNotificationKeys.remove(notificationKey);
    }

    public Set<String> getNotificationKeys() {
        return mNotificationKeys;
    }

    public int getNotificationCount() {
        return mNotificationKeys.size();
    }

    /**
     * Whether newBadge represents the same PackageUserKey as this badge, and icons with
     * this badge should be invalidated. So, for instance, if a badge has 3 notifications
     * and one of those notifications is updated, this method should return false because
     * the badge still says "3" and the contents of those notifications are only retrieved
     * upon long-click. This method always returns true when adding or removing notifications.
     */
    public boolean shouldBeInvalidated(BadgeInfo newBadge) {
        return mPackageUserKey.equals(newBadge.mPackageUserKey)
                && getNotificationCount() != newBadge.getNotificationCount();
    }
}