src/net/pterodactylus/fcp/GetPluginInfo.java

   1 /*
   2  * jSite2 - GetPluginInfo.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 “GetPluginInfo” message requests information about a plugin from the
  24  * node, which will response with a {@link PluginInfo} message.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class GetPluginInfo extends FcpMessage {
  29
  30         /**
  31          * Creates a new “GetPluginInfo” message.
  32          *
  33          * @param pluginName
  34          *            The name of the plugin
  35          * @param identifier
  36          *            The identifier of the request
  37          */
  38         public GetPluginInfo(String pluginName, String identifier) {
  39                 super("GetPluginInfo");
  40                 setField("PluginName", pluginName);
  41                 setField("Identifier", identifier);
  42         }
  43
  44         /**
  45          * Sets whether detailed information about the plugin is wanted.
  46          *
  47          * @param detailed
  48          *            <code>true</code> to request detailed information about the
  49          *            plugin, <code>false</code> otherwise
  50          */
  51         public void setDetailed(boolean detailed) {
  52                 setField("Detailed", String.valueOf(detailed));
  53         }
  54
  55 }