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

   1 /*
   2  * jFCPlib - PluginMessage.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 import java.io.InputStream;
  22
  23 /**
  24  * An “CPPluginMessage” sends a message with custom parameters and (optional)
  25  * payload to a plugin.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  */
  29 public class FCPPluginMessage extends FcpMessage {
  30
  31         /**
  32          * @deprecated Use {@link #FCPPluginMessage(String, String)} instead
  33          */
  34         @Deprecated
  35         public FCPPluginMessage(String pluginClass) {
  36                 super("FCPPluginMessage");
  37                 setField("PluginName", pluginClass);
  38         }
  39
  40         public FCPPluginMessage(String identifier, String pluginClass) {
  41                 this(pluginClass);
  42                 setField("Identifier", identifier);
  43         }
  44
  45         /**
  46          * @deprecated Use {@link #FCPPluginMessage(String, String)} instead
  47          */
  48         @Deprecated
  49         public void setIdentifier(String identifier) {
  50                 setField("Identifier", identifier);
  51         }
  52
  53         /**
  54          * Sets a custom parameter for the plugin.
  55          *
  56          * @param key
  57          *      The key of the parameter
  58          * @param value
  59          *      The value of the parameter
  60          */
  61         public void setParameter(String key, String value) {
  62                 setField("Param." + key, value);
  63         }
  64
  65         /**
  66          * @deprecated Use {@link #setData(InputStream, long)} instead
  67          */
  68         @Deprecated
  69         public void setDataLength(long dataLength) {
  70                 setField("DataLength", String.valueOf(dataLength));
  71         }
  72
  73         public void setData(InputStream payloadInputStream, long dataLength) {
  74                 setPayloadInputStream(payloadInputStream);
  75                 setDataLength(dataLength);
  76         }
  77
  78 }