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

   1 /*
   2  * jFCPlib - BaseMessage.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 java.util.Map;
  21
  22 /**
  23  * A basic message abstraction that wraps a received FCP message.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class BaseMessage {
  28
  29         /** The received message, wrapped here. */
  30         private final FcpMessage receivedMessage;
  31
  32         /**
  33          * Creates a new base message that wraps the given message.
  34          *
  35          * @param receivedMessage
  36          *            The FCP message that was received
  37          */
  38         BaseMessage(FcpMessage receivedMessage) {
  39                 this.receivedMessage = receivedMessage;
  40         }
  41
  42         /**
  43          * Returns the name of the message.
  44          *
  45          * @return The name of the message
  46          */
  47         public String getName() {
  48                 return receivedMessage.getName();
  49         }
  50
  51         /**
  52          * Returns the content of the field.
  53          *
  54          * @param field
  55          *            The name of the field
  56          * @return The content of the field, or <code>null</code> if there is no
  57          *         such field
  58          */
  59         public String getField(String field) {
  60                 return receivedMessage.getField(field);
  61         }
  62
  63         /**
  64          * Returns all fields from the received message.
  65          *
  66          * @see FcpMessage#getFields()
  67          * @return All fields from the message
  68          */
  69         public Map<String, String> getFields() {
  70                 return receivedMessage.getFields();
  71         }
  72
  73 }