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
  31          * node.
  32          */
  33         public GetNode() {
  34                 this(null, null, null);
  35         }
  36
  37         /**
  38          * Creates a “GetNode” command that returns the request noderef of the
  39          * node, including private and volatile data, if requested. If any of the
  40          * Boolean parameters are <code>null</code> the parameter is ignored and
  41          * the node’s default value is used.
  42          *
  43          * @param giveOpennetRef
  44          *            <code>true</code> to request the opennet noderef,
  45          *            <code>false</code> for darknet
  46          * @param withPrivate
  47          *            <code>true</code> to include private data in the noderef
  48          * @param withVolatile
  49          *            <code>true</code> to include volatile data in the noderef
  50          */
  51         public GetNode(Boolean giveOpennetRef, Boolean withPrivate, Boolean withVolatile) {
  52                 super("GetNode");
  53                 if (giveOpennetRef != null) {
  54                         setField("GiveOpennetRef", String.valueOf(giveOpennetRef));
  55                 }
  56                 if (withPrivate != null) {
  57                         setField("WithPrivate", String.valueOf(withPrivate));
  58                 }
  59                 if (withVolatile != null) {
  60                         setField("WithVolatile", String.valueOf(withVolatile));
  61                 }
  62         }
  63
  64 }