059a47a69401cc94e4cdfffe1cfa8cfbec748246
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / PluginInfo.java
1 /*
2  * jFCPlib - PluginInfo.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 “PluginInfo” message is a reply to the {@link GetPluginInfo} request.
23  *
24  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
25  */
26 public class PluginInfo extends BaseMessage implements Identifiable {
27
28         /**
29          * Creates a new “PluginInfo” message that wraps the received message.
30          *
31          * @param receivedMessage
32          *            The received message
33          */
34         public PluginInfo(FcpMessage receivedMessage) {
35                 super(receivedMessage);
36         }
37
38         /**
39          * Returns the name of the plugin.
40          *
41          * @return The name of the plugin
42          */
43         public String getPluginName() {
44                 return getField("PluginName");
45         }
46
47         /**
48          * Returns the identifier of the request.
49          *
50          * @return The identifier of the request
51          */
52         @Override
53         public String getIdentifier() {
54                 return getField("Identifier");
55         }
56
57         /**
58          * Returns the original URI of the plugin.
59          *
60          * @return The original URI of the plugin
61          */
62         public String getOriginalURI() {
63                 return getField("OriginUri");
64         }
65
66         /**
67          * Returns whether the plugin is started.
68          *
69          * @return <code>true</code> if the plugin is started, <code>false</code>
70          *         otherwise
71          */
72         public boolean isStarted() {
73                 return Boolean.valueOf("Started");
74         }
75
76 }