src/net/pterodactylus/fcp/BaseMessage.java

   1 /*
   2  * jSite2 - BaseMessage.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp;
  21
  22 import java.util.Map;
  23
  24 /**
  25  * A basic message abstraction that wraps a received FCP message.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  * @version $Id$
  29  */
  30 public class BaseMessage {
  31
  32         /** The received message, wrapped here. */
  33         private final FcpMessage receivedMessage;
  34
  35         /**
  36          * Creates a new base message that wraps the given message.
  37          *
  38          * @param receivedMessage
  39          *            The FCP message that was received
  40          */
  41         BaseMessage(FcpMessage receivedMessage) {
  42                 this.receivedMessage = receivedMessage;
  43         }
  44
  45         /**
  46          * Returns the name of the message.
  47          *
  48          * @return The name of the message
  49          */
  50         public String getName() {
  51                 return receivedMessage.getName();
  52         }
  53
  54         /**
  55          * Returns the content of the field.
  56          *
  57          * @param field
  58          *            The name of the field
  59          * @return The content of the field, or <code>null</code> if there is no
  60          *         such field
  61          */
  62         protected String getField(String field) {
  63                 return receivedMessage.getField(field);
  64         }
  65
  66         /**
  67          * Returns all fields from the received message.
  68          *
  69          * @see FcpMessage#getFields()
  70          * @return All fields from the message
  71          */
  72         protected Map<String, String> getFields() {
  73                 return receivedMessage.getFields();
  74         }
  75
  76 }