423bea47a3d996b34d70c370363229660f80f1af
[Sone.git] / src / main / java / net / pterodactylus / sone / notify / ListNotification.java
1 /*
2  * Sone - ListNotification.java - Copyright © 2010 David Roden
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17
18 package net.pterodactylus.sone.notify;
19
20 import java.util.ArrayList;
21 import java.util.Collections;
22 import java.util.List;
23
24 import net.pterodactylus.util.notify.TemplateNotification;
25 import net.pterodactylus.util.template.Template;
26
27 /**
28  * Notification that maintains a list of new elements.
29  *
30  * @param <T>
31  *            The type of the items
32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33  */
34 public class ListNotification<T> extends TemplateNotification {
35
36         /** The list of new elements. */
37         private final List<T> elements = Collections.synchronizedList(new ArrayList<T>());
38
39         /**
40          * Creates a new list notification.
41          *
42          * @param id
43          *            The ID of the notification
44          * @param key
45          *            The key under which to store the elements in the template
46          * @param template
47          *            The template to render
48          */
49         public ListNotification(String id, String key, Template template) {
50                 super(id, template);
51                 template.set(key, elements);
52         }
53
54         //
55         // ACTIONS
56         //
57
58         /**
59          * Returns whether there are any new elements.
60          *
61          * @return {@code true} if there are no new elements, {@code false} if there
62          *         are new elements
63          */
64         public boolean isEmpty() {
65                 return elements.isEmpty();
66         }
67
68         /**
69          * Adds a discovered element.
70          *
71          * @param element
72          *            The new element
73          */
74         public void add(T element) {
75                 elements.add(element);
76                 touch();
77         }
78
79         /**
80          * Removes the given element from the list of new elements.
81          *
82          * @param element
83          *            The element to remove
84          */
85         public void remove(T element) {
86                 elements.remove(element);
87                 if (elements.isEmpty()) {
88                         dismiss();
89                 }
90                 touch();
91         }
92
93         //
94         // ABSTRACTNOTIFICATION METHODS
95         //
96
97         /**
98          * {@inheritDoc}
99          */
100         @Override
101         public void dismiss() {
102                 super.dismiss();
103                 elements.clear();
104         }
105
106 }