Remove javadoc comments from overriding methods.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / ajax / DismissNotificationAjaxPage.java
1 /*
2  * Sone - DismissNotificationAjaxPage.java - Copyright © 2010–2013 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.web.ajax;
19
20 import net.pterodactylus.sone.web.WebInterface;
21 import net.pterodactylus.sone.web.page.FreenetRequest;
22 import net.pterodactylus.util.notify.Notification;
23
24 /**
25  * AJAX page that lets the user dismiss a notification.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public class DismissNotificationAjaxPage extends JsonPage {
30
31         /**
32          * Creates a new “dismiss notification” AJAX handler.
33          *
34          * @param webInterface
35          *            The Sone web interface
36          */
37         public DismissNotificationAjaxPage(WebInterface webInterface) {
38                 super("dismissNotification.ajax", webInterface);
39         }
40
41         @Override
42         protected JsonReturnObject createJsonObject(FreenetRequest request) {
43                 String notificationId = request.getHttpRequest().getParam("notification");
44                 Notification notification = webInterface.getNotifications().getNotification(notificationId);
45                 if (notification == null) {
46                         return createErrorJsonObject("invalid-notification-id");
47                 }
48                 if (!notification.isDismissable()) {
49                         return createErrorJsonObject("not-dismissable");
50                 }
51                 notification.dismiss();
52                 return createSuccessJsonObject();
53         }
54
55         @Override
56         protected boolean requiresLogin() {
57                 return false;
58         }
59
60 }