Fix javadoc
[Sone.git] / src / main / java / net / pterodactylus / sone / fcp / LockSoneCommand.java
1 /*
2  * Sone - LockSoneCommand.java - Copyright © 2013–2016 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.fcp;
19
20 import net.pterodactylus.sone.core.Core;
21 import net.pterodactylus.sone.data.Sone;
22 import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder;
23 import net.pterodactylus.sone.freenet.fcp.FcpException;
24
25 import freenet.support.SimpleFieldSet;
26
27 import com.google.common.base.Optional;
28
29 /**
30  * Implements the “LockSone” FCP command. If a valid local Sone was given as
31  * parameter “Sone,” this command will always lock the Sone and reply with
32  * “SoneLocked.”
33  *
34  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
35  */
36 public class LockSoneCommand extends AbstractSoneCommand {
37
38         /**
39          * Creates a new “LockSone” FCP command.
40          *
41          * @param core
42          *              The core to operate on
43          */
44         public LockSoneCommand(Core core) {
45                 super(core, true);
46         }
47
48         //
49         // COMMAND METHODS
50         //
51
52         @Override
53         public Response execute(SimpleFieldSet parameters) throws FcpException {
54                 Optional<Sone> sone = getSone(parameters, "Sone", true, true);
55                 getCore().lockSone(sone.get());
56                 return new Response("SoneLocked", new SimpleFieldSetBuilder().put("Sone", sone.get().getId()).get());
57         }
58
59 }