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

   1 /*
   2  * jFCPlib - RemovePersistentRequest.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 “RemovePersistentRequest” message tells the node to remove a persistent
  22  * request, cancelling it first (resulting in a {@link GetFailed} or
  23  * {@link PutFailed} message), if necessary.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class RemovePersistentRequest extends FcpMessage {
  28
  29         /**
  30          * Creates a new “RemovePersistentRequest” message.
  31          *
  32          * @param identifier
  33          *            The identifier of the request
  34          */
  35         public RemovePersistentRequest(String identifier) {
  36                 super("RemovePersistentRequest");
  37                 setField("Identifier", identifier);
  38         }
  39
  40         /**
  41          * Sets whether the request is on the global queue.
  42          *
  43          * @param global
  44          *            <code>true</code> if the request is on the global queue,
  45          *            <code>false</code> if it is on the client-local queue
  46          */
  47         public void setGlobal(boolean global) {
  48                 setField("Global", String.valueOf(global));
  49         }
  50
  51 }