src/net/pterodactylus/fcp/FinishedCompression.java

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