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.Collection;
  22 import java.util.List;
  23 import java.util.concurrent.CopyOnWriteArrayList;
  24
  25 import net.pterodactylus.util.notify.TemplateNotification;
  26 import net.pterodactylus.util.template.Template;
  27
  28 /**
  29  * Notification that maintains a list of new elements.
  30  *
  31  * @param <T>
  32  *            The type of the items
  33  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  34  */
  35 public class ListNotification<T> extends TemplateNotification {
  36
  37         /** The key under which to store the elements in the template. */
  38         private final String key;
  39
  40         /** The list of new elements. */
  41         private final List<T> elements = new CopyOnWriteArrayList<T>();
  42
  43         /**
  44          * Creates a new list notification.
  45          *
  46          * @param id
  47          *            The ID of the notification
  48          * @param key
  49          *            The key under which to store the elements in the template
  50          * @param template
  51          *            The template to render
  52          */
  53         public ListNotification(String id, String key, Template template) {
  54                 super(id, template);
  55                 this.key = key;
  56                 template.getInitialContext().set(key, elements);
  57         }
  58
  59         /**
  60          * Creates a new list notification that copies its ID and the template from
  61          * the given list notification.
  62          *
  63          * @param listNotification
  64          *            The list notification to copy
  65          */
  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);
  71         }
  72
  73         //
  74         // ACTIONS
  75         //
  76
  77         /**
  78          * Returns the current list of elements.
  79          *
  80          * @return The current list of elements
  81          */
  82         public List<T> getElements() {
  83                 return new ArrayList<T>(elements);
  84         }
  85
  86         /**
  87          * Returns whether there are any new elements.
  88          *
  89          * @return {@code true} if there are no new elements, {@code false} if there
  90          *         are new elements
  91          */
  92         public boolean isEmpty() {
  93                 return elements.isEmpty();
  94         }
  95
  96         /**
  97          * Adds a discovered element.
  98          *
  99          * @param element
 100          *            The new element
 101          */
 102         public void add(T element) {
 103                 elements.add(element);
 104                 touch();
 105         }
 106
 107         /**
 108          * Removes the given element from the list of new elements.
 109          *
 110          * @param element
 111          *            The element to remove
 112          */
 113         public void remove(T element) {
 114                 elements.remove(element);
 115                 if (elements.isEmpty()) {
 116                         dismiss();
 117                 }
 118                 touch();
 119         }
 120
 121         //
 122         // ABSTRACTNOTIFICATION METHODS
 123         //
 124
 125         /**
 126          * {@inheritDoc}
 127          */
 128         @Override
 129         public void dismiss() {
 130                 super.dismiss();
 131                 elements.clear();
 132         }
 133
 134 }