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

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