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

   1 /*
   2  * jFCPlib - PeerNote.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 import com.google.common.base.Charsets;
  22
  23 /**
  24  * The “PeerNote” message contains a private note that has been entered for a
  25  * darknet peer.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  */
  29 public class PeerNote extends BaseMessage {
  30
  31         private static final FreenetBase64 BASE64_DECODER = new FreenetBase64();
  32
  33         /** The type for base64 encoded peer notes. */
  34         public static final int TYPE_PRIVATE_PEER_NOTE = 1;
  35
  36         /**
  37          * Creates a “PeerNote” message that wraps the recevied message.
  38          *
  39          * @param receivedMessage
  40          *            The received message
  41          */
  42         public PeerNote(FcpMessage receivedMessage) {
  43                 super(receivedMessage);
  44         }
  45
  46         /**
  47          * Returns the identifier of the node this note belongs to.
  48          *
  49          * @return The note’s node’s identifier
  50          */
  51         public String getNodeIdentifier() {
  52                 return getField("NodeIdentifier");
  53         }
  54
  55         /**
  56          * Returns the base64-encoded note text.
  57          *
  58          * @return The note text
  59          */
  60         public String getNoteText() {
  61                 return new String(BASE64_DECODER.decode(getField("NoteText")), Charsets.UTF_8);
  62         }
  63
  64         /**
  65          * Returns the type of the peer note.
  66          *
  67          * @return The type of the peer note, or <code>-1</code> if the type can
  68          *         not be parsed
  69          */
  70         public int getPeerNoteType() {
  71                 return FcpUtils.safeParseInt(getField("PeerNoteType"));
  72         }
  73
  74 }