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

   1 /*
   2  * jFCPlib - FinishedCompression.java - Copyright © 2008–2016 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 3 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.fcp;
  19
  20 /**
  21  * A “FinishedCompression” message signals the client that the compression of
  22  * the request data has been finished.
  23  *
  24  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  25  */
  26 public class FinishedCompression extends BaseMessage implements Identifiable {
  27
  28         /**
  29          * Creates a new “FinishedCompression” message that wraps the received
  30          * message.
  31          *
  32          * @param receivedMessage
  33          *            The message that was recevied
  34          */
  35         public FinishedCompression(FcpMessage receivedMessage) {
  36                 super(receivedMessage);
  37         }
  38
  39         /**
  40          * Returns the identifier of the request.
  41          *
  42          * @return The identifier of the request
  43          */
  44         @Override
  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 }