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

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