Make all node-side message constructors public
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / PersistentRequestModified.java
1 /*
2  * jFCPlib - PersistentRequestModified.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 “PersistentRequestModified” message is a reply to
23  * {@link ModifyPersistentRequest}.
24  *
25  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
26  */
27 public class PersistentRequestModified extends BaseMessage implements Identifiable {
28
29         /**
30          * Creates a new “PersistentRequestModified” message that wraps the
31          * received message.
32          *
33          * @param receivedMessage
34          *            The received message
35          */
36         public PersistentRequestModified(FcpMessage receivedMessage) {
37                 super(receivedMessage);
38         }
39
40         /**
41          * Returns the identifier of the changed request.
42          *
43          * @return The identifier of the request
44          */
45         @Override
46         public String getIdentifier() {
47                 return getField("Identifier");
48         }
49
50         /**
51          * Returns whether the request is on the global queue.
52          *
53          * @return <code>true</code> if the request is on the global queue,
54          *         <code>false</code> if it is on a client-local queue
55          */
56         public boolean isGlobal() {
57                 return Boolean.valueOf(getField("Global"));
58         }
59
60         /**
61          * Returns the client token, if it was changed.
62          *
63          * @return The new client token, or <code>null</code> if the client token
64          *         was not changed
65          */
66         public String getClientToken() {
67                 return getField("ClientToken");
68         }
69
70         /**
71          * Returns the priority of the request, if it was changed.
72          *
73          * @return The new priority of the request, or {@link Priority#unknown} if
74          *         the priority was not changed
75          */
76         public Priority getPriority() {
77                 return Priority.values()[FcpUtils.safeParseInt(getField("PriorityClass"), Priority.unknown.ordinal())];
78         }
79
80 }