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

   1 /*
   2  * jFCPlib - GetNode.java - Copyright © 2008–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.fcp;
  19
  20 /**
  21  * The “GetNode” command returns the darknet or opennet noderef of the node,
  22  * optionally including private and volatile data.
  23  *
  24  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  25  */
  26 public class GetNode extends FcpMessage {
  27
  28         /**
  29          * Creates a “GetNode” command that returns the darknet noderef of the
  30          * 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
  38          * node, including private and volatile data, if requested. If any of the
  39          * Boolean parameters are <code>null</code> the parameter is ignored and
  40          * the node’s 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                 this(null, giveOpennetRef, withPrivate, withVolatile);
  52         }
  53
  54         public GetNode(String identifier, Boolean giveOpennetRef, Boolean withPrivate, Boolean withVolatile) {
  55                 super("GetNode");
  56                 if (identifier != null) {
  57                         setField("Identifier", identifier);
  58                 }
  59                 if (giveOpennetRef != null) {
  60                         setField("GiveOpennetRef", String.valueOf(giveOpennetRef));
  61                 }
  62                 if (withPrivate != null) {
  63                         setField("WithPrivate", String.valueOf(withPrivate));
  64                 }
  65                 if (withVolatile != null) {
  66                         setField("WithVolatile", String.valueOf(withVolatile));
  67                 }
  68         }
  69
  70 }