2 * Sone - ListNotification.java - Copyright © 2010 David Roden
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.
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.
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/>.
18 package net.pterodactylus.sone.notify;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.List;
23 import java.util.concurrent.CopyOnWriteArrayList;
25 import net.pterodactylus.util.notify.TemplateNotification;
26 import net.pterodactylus.util.template.Template;
29 * Notification that maintains a list of new elements.
32 * The type of the items
33 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35 public class ListNotification<T> extends TemplateNotification {
37 /** The key under which to store the elements in the template. */
38 private final String key;
40 /** The list of new elements. */
41 private final List<T> elements = new CopyOnWriteArrayList<T>();
44 * Creates a new list notification.
47 * The ID of the notification
49 * The key under which to store the elements in the template
51 * The template to render
53 public ListNotification(String id, String key, Template template) {
56 template.getInitialContext().set(key, elements);
60 * Creates a new list notification that copies its ID and the template from
61 * the given list notification.
63 * @param listNotification
64 * The list notification to copy
66 public ListNotification(ListNotification<T> listNotification) {
67 super(listNotification.getId(), new Template());
68 this.key = listNotification.key;
69 getTemplate().add(listNotification.getTemplate());
70 getTemplate().getInitialContext().set(key, elements);
78 * Returns the current list of elements.
80 * @return The current list of elements
82 public List<T> getElements() {
83 return new ArrayList<T>(elements);
87 * Sets the elements to show in this notification.
90 * The elements to show
92 public void setElements(Collection<? extends T> elements) {
93 this.elements.clear();
94 this.elements.addAll(elements);
99 * Returns whether there are any new elements.
101 * @return {@code true} if there are no new elements, {@code false} if there
104 public boolean isEmpty() {
105 return elements.isEmpty();
109 * Adds a discovered element.
114 public void add(T element) {
115 elements.add(element);
120 * Removes the given element from the list of new elements.
123 * The element to remove
125 public void remove(T element) {
126 elements.remove(element);
127 if (elements.isEmpty()) {
134 // ABSTRACTNOTIFICATION METHODS
141 public void dismiss() {