Fix javadoc.
[Sone.git] / src / main / java / net / pterodactylus / sone / fcp / GetSonesCommand.java
1 /*
2  * Sone - GetSonesCommand.java - Copyright © 2011–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.fcp;
19
20 import java.util.ArrayList;
21 import java.util.Collections;
22 import java.util.List;
23
24 import net.pterodactylus.sone.core.Core;
25 import net.pterodactylus.sone.data.Sone;
26 import net.pterodactylus.sone.freenet.fcp.FcpException;
27 import freenet.support.SimpleFieldSet;
28 import freenet.support.api.Bucket;
29
30 /**
31  * Implements the “GetSones” FCP command that returns the list of known Sones.
32  *
33  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
34  */
35 public class GetSonesCommand extends AbstractSoneCommand {
36
37         /**
38          * Creates a new “GetSones” FCP command.
39          *
40          * @param core
41          *            The Sone core
42          */
43         public GetSonesCommand(Core core) {
44                 super(core);
45         }
46
47         /**
48          * {@inheritDoc}
49          */
50         @Override
51         public Response execute(SimpleFieldSet parameters, Bucket data, AccessType accessType) throws FcpException {
52                 int startSone = getInt(parameters, "StartSone", 0);
53                 int maxSones = getInt(parameters, "MaxSones", -1);
54                 List<Sone> sones = new ArrayList<Sone>(getCore().getSones());
55                 if (sones.size() < startSone) {
56                         return new Response("Sones", encodeSones(Collections.<Sone> emptyList(), ""));
57                 }
58                 Collections.sort(sones, Sone.NICE_NAME_COMPARATOR);
59                 return new Response("Sones", encodeSones(sones.subList(startSone, (maxSones == -1) ? sones.size() : Math.min(startSone + maxSones, sones.size())), ""));
60         }
61
62 }