Enhance javadoc, remove obsolete isEmpty() method.
[Sone.git] / src / main / java / net / pterodactylus / sone / notify / NewSoneNotification.java
1 /*
2  * Sone - NewSoneNotification.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.sone.data.Sone;
25 import net.pterodactylus.util.notify.TemplateNotification;
26 import net.pterodactylus.util.template.Template;
27
28 /**
29  * Notification that signals that new Sones have been discovered.
30  *
31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
32  */
33 public class NewSoneNotification extends TemplateNotification {
34
35         /** The new Sones. */
36         private List<Sone> newSones = Collections.synchronizedList(new ArrayList<Sone>());
37
38         /**
39          * Creates a new “new Sone discovered” notification.
40          *
41          * @param template
42          *            The template to render
43          */
44         public NewSoneNotification(Template template) {
45                 super(template);
46                 template.set("sones", newSones);
47         }
48
49         //
50         // ACCESSORS
51         //
52
53         /**
54          * Adds a discovered Sone.
55          *
56          * @param sone
57          *            The new Sone
58          */
59         public void addSone(Sone sone) {
60                 newSones.add(sone);
61                 touch();
62         }
63
64         //
65         // ABSTRACTNOTIFICATION METHODS
66         //
67
68         /**
69          * {@inheritDoc}
70          */
71         @Override
72         public void dismiss() {
73                 super.dismiss();
74                 newSones.clear();
75         }
76
77 }