src/net/pterodactylus/fcp/SubscribedUSKUpdate.java

   1 /*
   2  * jSite2 - SubscribedUSKUpdate.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 “SubscribedUSKUpdate” message is sent each time a new edition of a USK that
  24  * was previously subscribed to with {@link SubscribeUSK} was found. Note that
  25  * if the new edition that was found is several editions ahead of the currently
  26  * last known edition, you will received a SubscribedUSKUpdate for each edition
  27  * inbetween as welL!
  28  *
  29  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  30  */
  31 public class SubscribedUSKUpdate extends BaseMessage {
  32
  33         /**
  34          * Creates a new “SubscribedUSKUpdate” message that wraps the received
  35          * message.
  36          *
  37          * @param receivedMessage
  38          *            The received message
  39          */
  40         SubscribedUSKUpdate(FcpMessage receivedMessage) {
  41                 super(receivedMessage);
  42         }
  43
  44         /**
  45          * Returns the identifier of the subscription.
  46          *
  47          * @return The identifier of the subscription
  48          */
  49         public String getIdentifier() {
  50                 return getField("Identifier");
  51         }
  52
  53         /**
  54          * Returns the new edition that was found.
  55          *
  56          * @return The new edition
  57          */
  58         public int getEdition() {
  59                 return FcpUtils.safeParseInt(getField("Edition"));
  60         }
  61
  62         /**
  63          * Returns the complete URI, including the new edition.
  64          *
  65          * @return The complete URI
  66          */
  67         public String getURI() {
  68                 return getField("URI");
  69         }
  70
  71 }