src/net/pterodactylus/fcp/ListPeers.java

   1 /*
   2  * jSite2 - ListPeers.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp;
  21
  22 /**
  23  * The “ListPeer” requests asks the node for a list of all peers it has.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  * @version $Id$
  27  */
  28 public class ListPeers extends FcpMessage {
  29
  30         /**
  31          * Creates a new “ListPeers” request that only includes basic data of the
  32          * peers.
  33          *
  34          * @param identifier
  35          *            The identifier of the request
  36          */
  37         public ListPeers(String identifier) {
  38                 this(identifier, false, false);
  39         }
  40
  41         /**
  42          * Creates a new “ListPeers” request that includes wanted data of the peers.
  43          *
  44          * @param identifier
  45          *            The identifier of the request
  46          * @param withMetadata
  47          *            If <code>true</code> metadata of the peers is included in
  48          *            the reply
  49          * @param withVolatile
  50          *            if <code>true</code> volatile data of the peers is included
  51          *            in the reply
  52          */
  53         public ListPeers(String identifier, boolean withMetadata, boolean withVolatile) {
  54                 super("ListPeers");
  55                 setField("Identifier", identifier);
  56                 setField("WithMetadata", String.valueOf(withMetadata));
  57                 setField("WithVolatile", String.valueOf(withVolatile));
  58         }
  59
  60 }