Fix header comments.
[Sone.git] / src / main / java / net / pterodactylus / sone / web / ajax / GetTranslationPage.java
1 /*
2  * Sone - GetTranslationPage.java - Copyright © 2010–2012 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.json.JsonObject;
23
24 /**
25  * Returns the translation for a given key as JSON object.
26  *
27  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
28  */
29 public class GetTranslationPage extends JsonPage {
30
31         /**
32          * Creates a new translation page.
33          *
34          * @param webInterface
35          *            The Sone web interface
36          */
37         public GetTranslationPage(WebInterface webInterface) {
38                 super("getTranslation.ajax", webInterface);
39         }
40
41         //
42         // JSONPAGE METHODS
43         //
44
45         /**
46          * {@inheritDoc}
47          */
48         @Override
49         protected JsonObject createJsonObject(FreenetRequest request) {
50                 String key = request.getHttpRequest().getParam("key");
51                 String translation = webInterface.getL10n().getString(key);
52                 return createSuccessJsonObject().put("value", translation);
53         }
54
55         /**
56          * {@inheritDoc}
57          */
58         @Override
59         protected boolean needsFormPassword() {
60                 return false;
61         }
62
63         /**
64          * {@inheritDoc}
65          */
66         @Override
67         protected boolean requiresLogin() {
68                 return false;
69         }
70
71 }