Make all node-side message constructors public
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / DataFound.java
1 /*
2  * jFCPlib - DataFound.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 “DataFound” message signals the client that the data requested by a
23  * {@link ClientGet} operation has been found. This message does not include
24  * the actual data, though.
25  *
26  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
27  */
28 public class DataFound extends BaseMessage implements Identifiable {
29
30         /**
31          * Creates a new “DataFound” message that wraps the received message.
32          *
33          * @param receivedMessage
34          *            The received message
35          */
36         public DataFound(FcpMessage receivedMessage) {
37                 super(receivedMessage);
38         }
39
40         /**
41          * Returns whether the request is on the global queue.
42          *
43          * @return <code>true</code> if the request is on the global queue,
44          *         <code>false</code> if the request is on the client-local queue
45          */
46         public boolean isGlobal() {
47                 return Boolean.valueOf(getField("Global"));
48         }
49
50         /**
51          * Returns the identifier of the request.
52          *
53          * @return The identifier of the request
54          */
55         @Override
56         public String getIdentifier() {
57                 return getField("Identifier");
58         }
59
60         /**
61          * Returns the content type of the data.
62          *
63          * @return The content type of the data
64          */
65         public String getMetadataContentType() {
66                 return getField("Metadata.ContentType");
67         }
68
69         /**
70          * Returns the length of the data.
71          *
72          * @return The length of the data
73          */
74         public long getDataLength() {
75                 return FcpUtils.safeParseLong(getField("DataLength"));
76         }
77
78 }