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

   1 /*
   2  * jFCPlib - ModifyPersistentRequest.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 /**
  22  * A “ModifyPersistentRequest” is used to modify certain properties of a
  23  * persistent request while it is running.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class ModifyPersistentRequest extends FcpMessage {
  28
  29         /**
  30          * Creates a new “ModifyPersistentRequest” that changes the specified
  31          * request.
  32          *
  33          * @param requestIdentifier
  34          *            The identifier of the request
  35          * @param global
  36          *            <code>true</code> if the request is on the global queue,
  37          *            <code>false</code> if it is on the client-local queue
  38          */
  39         public ModifyPersistentRequest(String requestIdentifier, boolean global) {
  40                 super("ModifyPersistentRequest");
  41                 setField("Identifier", requestIdentifier);
  42                 setField("Global", String.valueOf(global));
  43         }
  44
  45         /**
  46          * Sets the new client token of the request.
  47          *
  48          * @param newClientToken
  49          *            The new client token of the request
  50          */
  51         public void setClientToken(String newClientToken) {
  52                 setField("ClientToken", newClientToken);
  53         }
  54
  55         /**
  56          * Sets the new priority of the request.
  57          *
  58          * @param newPriority
  59          *            The new priority of the request
  60          */
  61         public void setPriority(Priority newPriority) {
  62                 setField("PriorityClass", String.valueOf(newPriority));
  63         }
  64
  65 }