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  * @version $Id$
  27  */
  28 public class PluginInfo extends BaseMessage {
  29
  30         /**
  31          * Creates a new “PluginInfo” message that wraps the received message.
  32          *
  33          * @param receivedMessage
  34          *            The received message
  35          */
  36         PluginInfo(FcpMessage receivedMessage) {
  37                 super(receivedMessage);
  38         }
  39
  40         /**
  41          * Returns the name of the plugin.
  42          *
  43          * @return The name of the plugin
  44          */
  45         public String getPluginName() {
  46                 return getField("PluginName");
  47         }
  48
  49         /**
  50          * Returns the identifier of the request.
  51          *
  52          * @return The identifier of the request
  53          */
  54         public String getIdentifier() {
  55                 return getField("Identifier");
  56         }
  57
  58         /**
  59          * Returns the original URI of the plugin.
  60          *
  61          * @return The original URI of the plugin
  62          */
  63         public String getOriginalURI() {
  64                 return getField("OriginalUri");
  65         }
  66
  67         /**
  68          * Returns whether the plugin is started.
  69          *
  70          * @return <code>true</code> if the plugin is started, <code>false</code>
  71          *         otherwise
  72          */
  73         public boolean isStarted() {
  74                 return Boolean.valueOf("Started");
  75         }
  76
  77 }