767b4ad4747fd940db2fd1baca7a2cf900773151
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / PutFetchable.java
1 /*
2  * jFCPlib - PutFetchable.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 “PutFetchable” message informs a client that a {@link ClientPut} request
23  * has progressed far enough that the resulting final URI might already be
24  * fetchable.
25  *
26  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
27  */
28 public class PutFetchable extends BaseMessage implements Identifiable {
29
30         /**
31          * Creates a new “PutFetchable” message that wraps the received message.
32          *
33          * @param receivedMessage
34          *            The received message
35          */
36         PutFetchable(FcpMessage receivedMessage) {
37                 super(receivedMessage);
38         }
39
40         /**
41          * Returns the identifier of the 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 the client-local queue
55          */
56         public boolean isGlobal() {
57                 return Boolean.valueOf(getField("Global"));
58         }
59
60         /**
61          * Returns the URI of the request.
62          *
63          * @return The URI of the request
64          */
65         public String getURI() {
66                 return getField("URI");
67         }
68
69 }