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

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