2 * Sone - ListNotification.java - Copyright © 2010–2019 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
34 public class ListNotification<T> extends TemplateNotification {
36 /** The key under which to store the elements in the template. */
37 private final String key;
39 /** The list of new elements. */
40 private final List<T> elements = new CopyOnWriteArrayList<>();
43 * Creates a new list notification.
46 * The ID of the notification
48 * The key under which to store the elements in the template
50 * The template to render
52 public ListNotification(String id, String key, Template template) {
53 this(id, key, template, true);
57 * Creates a new list notification.
60 * The ID of the notification
62 * The key under which to store the elements in the template
64 * The template to render
66 * {@code true} if this notification should be dismissable by the
67 * user, {@code false} otherwise
69 public ListNotification(String id, String key, Template template, boolean dismissable) {
70 super(id, System.currentTimeMillis(), System.currentTimeMillis(), dismissable, template);
72 template.getInitialContext().set(key, elements);
76 * Creates a new list notification that copies its ID and the template from
77 * the given list notification.
79 * @param listNotification
80 * The list notification to copy
82 public ListNotification(ListNotification<T> listNotification) {
83 super(listNotification.getId(), listNotification.getCreatedTime(), listNotification.getLastUpdatedTime(), listNotification.isDismissable(), new Template());
84 this.key = listNotification.key;
85 getTemplate().add(listNotification.getTemplate());
86 getTemplate().getInitialContext().set(key, elements);
94 * Returns the current list of elements.
96 * @return The current list of elements
98 public List<T> getElements() {
99 return new ArrayList<>(elements);
103 * Sets the elements to show in this notification. This method will not call
107 * The elements to show
109 public void setElements(Collection<? extends T> elements) {
110 this.elements.clear();
111 this.elements.addAll(elements);
116 * Returns whether there are any new elements.
118 * @return {@code true} if there are no new elements, {@code false} if there
121 public boolean isEmpty() {
122 return elements.isEmpty();
126 * Adds a discovered element.
131 public void add(T element) {
132 elements.add(element);
137 * Removes the given element from the list of new elements.
140 * The element to remove
142 public void remove(T element) {
143 while (elements.remove(element)) {
144 /* do nothing, just remove all instances of the element. */
146 if (elements.isEmpty()) {
153 // ABSTRACTNOTIFICATION METHODS
160 public void dismiss() {
173 public int hashCode() {
174 int hashCode = super.hashCode();
175 for (T element : elements) {
176 hashCode ^= element.hashCode();
185 public boolean equals(Object object) {
186 if (!(object instanceof ListNotification)) {
189 ListNotification<?> listNotification = (ListNotification<?>) object;
190 if (!super.equals(listNotification)) {
193 if (!key.equals(listNotification.key)) {
196 return elements.equals(listNotification.elements);