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