src/main/java/net/pterodactylus/fcp/PluginInfo.java

   1 /*
   2  * jFCPlib - PluginInfo.java - Copyright © 2008–2016 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 3 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.fcp;
  19
  20 /**
  21  * The “PluginInfo” message is a reply to the {@link GetPluginInfo} request.
  22  *
  23  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  24  */
  25 public class PluginInfo extends BaseMessage implements Identifiable {
  26
  27         /**
  28          * Creates a new “PluginInfo” message that wraps the received message.
  29          *
  30          * @param receivedMessage
  31          *            The received message
  32          */
  33         public PluginInfo(FcpMessage receivedMessage) {
  34                 super(receivedMessage);
  35         }
  36
  37         /**
  38          * Returns the name of the plugin.
  39          *
  40          * @return The name of the plugin
  41          */
  42         public String getPluginName() {
  43                 return getField("PluginName");
  44         }
  45
  46         /**
  47          * Returns the identifier of the request.
  48          *
  49          * @return The identifier of the request
  50          */
  51         @Override
  52         public String getIdentifier() {
  53                 return getField("Identifier");
  54         }
  55
  56         /**
  57          * Returns the original URI of the plugin.
  58          *
  59          * @return The original URI of the plugin
  60          */
  61         public String getOriginalURI() {
  62                 return getField("OriginUri");
  63         }
  64
  65         /**
  66          * Returns whether the plugin is started.
  67          *
  68          * @return <code>true</code> if the plugin is started, <code>false</code>
  69          *         otherwise
  70          */
  71         public boolean isStarted() {
  72                 return Boolean.valueOf(getField("Started"));
  73         }
  74
  75         public boolean isTalkable() {
  76                 return Boolean.valueOf(getField("IsTalkable"));
  77         }
  78
  79         public String getVersion() {
  80                 return getField("Version");
  81         }
  82
  83         public String getLongVersion() {
  84                 return getField("LongVersion");
  85         }
  86 }