src/net/pterodactylus/fcp/DataFound.java

   1 /*
   2  * jSite2 - DataFound.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 “DataFound” message signals the client that the data requested by a
  24  * {@link ClientGet} operation has been found. This message does not include the
  25  * actual data, though.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  */
  29 public class DataFound extends BaseMessage {
  30
  31         /**
  32          * Creates a new “DataFound” message that wraps the received message.
  33          *
  34          * @param receivedMessage
  35          *            The received message
  36          */
  37         DataFound(FcpMessage receivedMessage) {
  38                 super(receivedMessage);
  39         }
  40
  41         /**
  42          * Returns whether the request is on the global queue.
  43          *
  44          * @return <code>true</code> if the request is on the global queue,
  45          *         <code>false</code> if the request is on the client-local queue
  46          */
  47         public boolean isGlobal() {
  48                 return Boolean.valueOf(getField("Global"));
  49         }
  50
  51         /**
  52          * Returns the identifier of the request.
  53          *
  54          * @return The identifier of the request
  55          */
  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 }