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

   1 /*
   2  * jFCPlib - ModifyPeerNote.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 “ModifyPeerNote” command modifies a peer note.
  23  *
  24  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  25  */
  26 public class ModifyPeerNote extends FcpMessage {
  27
  28         /**
  29          * Creates a new “ModifyPeerNote” request that changes peer note of the
  30          * given type and node to the given text.
  31          *
  32          * @see PeerNote
  33          * @param nodeIdentifier
  34          *            The identifier of the node, i.e. name, identity, or IP
  35          *            address and port
  36          * @param noteText
  37          *            The base64-encoded text
  38          * @param peerNoteType
  39          *            The type of the note to change, possible values are only
  40          *            {@link PeerNote#TYPE_PRIVATE_PEER_NOTE} at the moment
  41          */
  42         public ModifyPeerNote(String nodeIdentifier, String noteText, int peerNoteType) {
  43                 super("ModifyPeer");
  44                 setField("NodeIdentifier", nodeIdentifier);
  45                 setField("NoteText", noteText);
  46                 setField("PeerNoteType", String.valueOf(peerNoteType));
  47         }
  48
  49 }