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