Add missing javadocs.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / OptionsPage.java
1 /*
2  * Sone - OptionsPage.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.web;
19
20 import net.pterodactylus.sone.core.Options;
21 import net.pterodactylus.sone.web.page.Page.Request.Method;
22 import net.pterodactylus.util.number.Numbers;
23 import net.pterodactylus.util.template.Template;
24
25 /**
26  * This page lets the user edit the options of the Sone plugin.
27  *
28  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
29  */
30 public class OptionsPage extends SoneTemplatePage {
31
32         /**
33          * Creates a new options page.
34          *
35          * @param template
36          *            The template to render
37          * @param webInterface
38          *            The Sone web interface
39          */
40         public OptionsPage(Template template, WebInterface webInterface) {
41                 super("options.html", template, "Page.Options.Title", webInterface);
42         }
43
44         //
45         // TEMPLATEPAGE METHODS
46         //
47
48         /**
49          * {@inheritDoc}
50          */
51         @Override
52         protected void processTemplate(Request request, Template template) throws RedirectException {
53                 super.processTemplate(request, template);
54                 Options options = webInterface.core().getOptions();
55                 if (request.getMethod() == Method.POST) {
56                         Integer insertionDelay = Numbers.safeParseInteger(request.getHttpRequest().getPartAsStringFailsafe("insertion-delay", 16));
57                         options.getIntegerOption("InsertionDelay").set(insertionDelay);
58                 }
59                 template.set("insertion-delay", options.getIntegerOption("InsertionDelay").get());
60                 template.set("clear-on-next-restart", options.getBooleanOption("ClearOnNextRestart").get());
61         }
62
63         //
64         // SONETEMPLATEPAGE METHODS
65         //
66
67         /**
68          * {@inheritDoc}
69          */
70         @Override
71         protected boolean requiresLogin() {
72                 return false;
73         }
74
75 }