src/net/pterodactylus/fcp/PluginInfo.java

   1 /*
   2  * jSite2 - PluginInfo.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 /**
  23  * The “PluginInfo” message is a reply to the {@link GetPluginInfo} request.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class PluginInfo extends BaseMessage {
  28
  29         /**
  30          * Creates a new “PluginInfo” message that wraps the received message.
  31          *
  32          * @param receivedMessage
  33          *            The received message
  34          */
  35         PluginInfo(FcpMessage receivedMessage) {
  36                 super(receivedMessage);
  37         }
  38
  39         /**
  40          * Returns the name of the plugin.
  41          *
  42          * @return The name of the plugin
  43          */
  44         public String getPluginName() {
  45                 return getField("PluginName");
  46         }
  47
  48         /**
  49          * Returns the identifier of the request.
  50          *
  51          * @return The identifier of the request
  52          */
  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("OriginalUri");
  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 }