aboutsummaryrefslogtreecommitdiffstats
path: root/src/net/java/sip/communicator/impl/gui/main/UINotification.java
blob: fbfb6da6b3f2e918fddce145a79c18240335beeb (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * 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 net.java.sip.communicator.impl.gui.main;

/**
 * The <tt>UINotification</tt> class represents a notification received in the
 * user interface. This could be a missed call, voicemail, email notification or
 * any other notification.
 *
 * @author Yana Stamcheva
 */
public class UINotification
{
    /**
     * The parent notification group.
     */
    private final UINotificationGroup parentGroup;

    /**
     * The name associated with this notification.
     */
    private final String notificationName;

    /**
     * The display name associated with this notification.
     */
    private final String notificationDisplayName;

    /**
     * The time in milliseconds when the notification was received.
     */
    private final long notificationTime;

    /**
     * Number of unread objects like calls or messages.
     */
    private int unreadObjects = 0;

    /**
     * Creates an instance of <tt>UINotification</tt> by specifying the
     * notification name and time.
     *
     * notification belongs
     * @param displayName the name associated to this notification
     * @param time the time in milliseconds when the notification was received
     * @param parentGroup the group of notifications, to which this notification
     * belongs
     */
    public UINotification(  String displayName,
                            long time,
                            UINotificationGroup parentGroup)
    {
        this(displayName, time, parentGroup, 1);
    }

    /**
     * Creates an instance of <tt>UINotification</tt> by specifying the
     * notification name and time.
     *
     * notification belongs
     * @param displayName the name associated to this notification
     * @param time the time in milliseconds when the notification was received
     * @param parentGroup the group of notifications, to which this notification
     * belongs
     * @param unreadObjects number of unread objects for this notification.
     */
    public UINotification(  String displayName,
                            long time,
                            UINotificationGroup parentGroup,
                            int unreadObjects)
    {
        this(displayName, displayName, time, parentGroup, 1);
    }

    /**
     * Creates an instance of <tt>UINotification</tt> by specifying the
     * notification name and time.
     *
     * notification belongs
     * @param name the notification name
     * @param displayName the name associated to this notification
     * @param time the time in milliseconds when the notification was received
     * @param parentGroup the group of notifications, to which this notification
     * belongs
     * @param unreadObjects number of unread objects for this notification.
     */
    public UINotification(  String name,
                            String displayName,
                            long time,
                            UINotificationGroup parentGroup,
                            int unreadObjects)
    {
        this.notificationName = name;
        this.notificationDisplayName = displayName;
        this.notificationTime = time;
        this.parentGroup = parentGroup;
        this.unreadObjects = unreadObjects;
    }

    /**
     * Returns the name associated with this notification.
     *
     * @return the name associated with this notification
     */
    public String getDisplayName()
    {
        return notificationDisplayName;
    }

    /**
     * Returns the time in milliseconds the notification was received.
     *
     * @return the time in milliseconds the notification was received
     */
    public long getTime()
    {
        return notificationTime;
    }

    /**
     * Returns the parent notification group.
     *
     * @return the parent notification group
     */
    public UINotificationGroup getGroup()
    {
        return parentGroup;
    }

    /**
     * Returns the number of unread objects for this notification.
     * @return
     */
    public int getUnreadObjects()
    {
        return unreadObjects;
    }

    @Override
    public boolean equals(Object o)
    {
        if(this == o)
            return true;
        if(o == null || getClass() != o.getClass())
            return false;

        UINotification that = (UINotification) o;

        if(notificationName != null ?
                !notificationName.equals(that.notificationName)
                : that.notificationName != null)
            return false;
        if(parentGroup != null ?
                !parentGroup.equals(that.parentGroup)
                : that.parentGroup != null)
            return false;

        return true;
    }
}