src/main/java/net/pterodactylus/fcp/FinishedCompression.java

   1 /*
   2  * jFCPlib - FinishedCompression.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 “FinishedCompression” message signals the client that the compression of
  23  * the request data has been finished.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class FinishedCompression extends BaseMessage implements Identifiable {
  28
  29         /**
  30          * Creates a new “FinishedCompression” message that wraps the received
  31          * message.
  32          *
  33          * @param receivedMessage
  34          *            The message that was recevied
  35          */
  36         FinishedCompression(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         public String getIdentifier() {
  46                 return getField("Identifier");
  47         }
  48
  49         /**
  50          * Returns the ID of the codec that was used for compression.
  51          *
  52          * @return The ID of the codec that was used for compression
  53          */
  54         public int getCodec() {
  55                 return FcpUtils.safeParseInt(getField("Codec"));
  56         }
  57
  58         /**
  59          * Returns the original size of the data (i.e. before compression).
  60          *
  61          * @return The original size of the data
  62          */
  63         public long getOriginalSize() {
  64                 return FcpUtils.safeParseLong(getField("OriginalSize"));
  65         }
  66
  67         /**
  68          * Returns the compressed size of the data (i.e. after compression).
  69          *
  70          * @return The compressed size of the data
  71          */
  72         public long getCompressedSize() {
  73                 return FcpUtils.safeParseLong(getField("CompressedSize"));
  74         }
  75
  76 }