src/main/java/net/pterodactylus/fcp/GetNode.java

   1 /*
   2  * jFCPlib - GetNode.java - Copyright © 2008 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 2 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, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package net.pterodactylus.fcp;
  20
  21 /**
  22  * The “GetNode” command returns the darknet or opennet noderef of the node,
  23  * optionally including private and volatile data.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class GetNode extends FcpMessage {
  28
  29         /**
  30          * Creates a “GetNode” command that returns the darknet noderef of the node.
  31          */
  32         public GetNode() {
  33                 this(null, null, null);
  34         }
  35
  36         /**
  37          * Creates a “GetNode” command that returns the request noderef of the node,
  38          * including private and volatile data, if requested. If any of the Boolean
  39          * parameters are <code>null</code> the parameter is ignored and the node’s
  40          * default value is used.
  41          *
  42          * @param giveOpennetRef
  43          *            <code>true</code> to request the opennet noderef,
  44          *            <code>false</code> for darknet
  45          * @param withPrivate
  46          *            <code>true</code> to include private data in the noderef
  47          * @param withVolatile
  48          *            <code>true</code> to include volatile data in the noderef
  49          */
  50         public GetNode(Boolean giveOpennetRef, Boolean withPrivate, Boolean withVolatile) {
  51                 super("GetNode");
  52                 if (giveOpennetRef != null) {
  53                         setField("GiveOpennetRef", String.valueOf(giveOpennetRef));
  54                 }
  55                 if (withPrivate != null) {
  56                         setField("WithPrivate", String.valueOf(withPrivate));
  57                 }
  58                 if (withVolatile != null) {
  59                         setField("WithVolatile", String.valueOf(withVolatile));
  60                 }
  61         }
  62
  63 }