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