2 * Sone - ListNotification.java - Copyright © 2010–2012 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) {
54 this(id, key, template, true);
58 * Creates a new list notification.
61 * The ID of the notification
63 * The key under which to store the elements in the template
65 * The template to render
67 * {@code true} if this notification should be dismissable by the
68 * user, {@code false} otherwise
70 public ListNotification(String id, String key, Template template, boolean dismissable) {
71 super(id, System.currentTimeMillis(), System.currentTimeMillis(), dismissable, template);
73 template.getInitialContext().set(key, elements);
77 * Creates a new list notification that copies its ID and the template from
78 * the given list notification.
80 * @param listNotification
81 * The list notification to copy
83 public ListNotification(ListNotification<T> listNotification) {
84 super(listNotification.getId(), listNotification.getCreatedTime(), listNotification.getLastUpdatedTime(), listNotification.isDismissable(), new Template());
85 this.key = listNotification.key;
86 getTemplate().add(listNotification.getTemplate());
87 getTemplate().getInitialContext().set(key, elements);
95 * Returns the current list of elements.
97 * @return The current list of elements
99 public List<T> getElements() {
100 return new ArrayList<T>(elements);
104 * Sets the elements to show in this notification. This method will not call
108 * The elements to show
110 public void setElements(Collection<? extends T> elements) {
111 this.elements.clear();
112 this.elements.addAll(elements);
117 * Returns whether there are any new elements.
119 * @return {@code true} if there are no new elements, {@code false} if there
122 public boolean isEmpty() {
123 return elements.isEmpty();
127 * Adds a discovered element.
132 public void add(T element) {
133 elements.add(element);
138 * Removes the given element from the list of new elements.
141 * The element to remove
143 public void remove(T element) {
144 elements.remove(element);
145 if (elements.isEmpty()) {
152 // ABSTRACTNOTIFICATION METHODS
159 public void dismiss() {
172 public int hashCode() {
173 int hashCode = super.hashCode();
174 for (T element : elements) {
175 hashCode ^= element.hashCode();
184 public boolean equals(Object object) {
185 if (!(object instanceof ListNotification)) {
188 ListNotification<?> listNotification = (ListNotification<?>) object;
189 if (!super.equals(listNotification)) {
192 if (!key.equals(listNotification.key)) {
195 if (elements.size() != listNotification.elements.size()) {
198 for (int index = 0; index < elements.size(); ++index) {
199 if (!elements.get(index).equals(listNotification.elements.get(index))) {