Expose the elements of the list notification.
[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 the current list of elements.
60          *
61          * @return The current list of elements
62          */
63         public List<T> getElements() {
64                 return new ArrayList<T>(elements);
65         }
66
67         /**
68          * Returns whether there are any new elements.
69          *
70          * @return {@code true} if there are no new elements, {@code false} if there
71          *         are new elements
72          */
73         public boolean isEmpty() {
74                 return elements.isEmpty();
75         }
76
77         /**
78          * Adds a discovered element.
79          *
80          * @param element
81          *            The new element
82          */
83         public void add(T element) {
84                 elements.add(element);
85                 touch();
86         }
87
88         /**
89          * Removes the given element from the list of new elements.
90          *
91          * @param element
92          *            The element to remove
93          */
94         public void remove(T element) {
95                 elements.remove(element);
96                 if (elements.isEmpty()) {
97                         dismiss();
98                 }
99                 touch();
100         }
101
102         //
103         // ABSTRACTNOTIFICATION METHODS
104         //
105
106         /**
107          * {@inheritDoc}
108          */
109         @Override
110         public void dismiss() {
111                 super.dismiss();
112                 elements.clear();
113         }
114
115 }