src/net/pterodactylus/fcp/PersistentRequestRemoved.java

   1 /*
   2  * jSite2 - PersistentRequestRemoved.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.fcp;
  21
  22 /**
  23  * A “PersistentRequestRemoved” message signals that a persistent request was
  24  * removed from either the global or the client-local queue.
  25  *
  26  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  27  */
  28 public class PersistentRequestRemoved extends BaseMessage {
  29
  30         /**
  31          * Creates a new “PersistentRequestRemoved” message that wraps the received
  32          * message.
  33          *
  34          * @param receivedMessage
  35          *            The received message
  36          */
  37         PersistentRequestRemoved(FcpMessage receivedMessage) {
  38                 super(receivedMessage);
  39         }
  40
  41         /**
  42          * Returns the identifier of the request.
  43          *
  44          * @return The identifier of the request
  45          */
  46         public String getIdentifier() {
  47                 return getField("Identifier");
  48         }
  49
  50         /**
  51          * Returns whether the request was removed from the global queue.
  52          *
  53          * @return <code>true</code> if the request was removed from the global
  54          *         queue, <code>false</code> if it was removed from the client-local
  55          *         queue
  56          */
  57         public boolean isGlobal() {
  58                 return Boolean.valueOf(getField("Global"));
  59         }
  60
  61 }