From d479253768d296a40b4f699e1de9b03c7146a97a Mon Sep 17 00:00:00 2001 From: Jesse Morgan Date: Tue, 3 Dec 2013 14:03:28 -0800 Subject: Adding javadocs and Carbonado User Guide --- .../com/amazon/carbonado/raw/GzipCompressor.html | 294 +++++++++++++++++++++ 1 file changed, 294 insertions(+) create mode 100644 apidocs/com/amazon/carbonado/raw/GzipCompressor.html (limited to 'apidocs/com/amazon/carbonado/raw/GzipCompressor.html') diff --git a/apidocs/com/amazon/carbonado/raw/GzipCompressor.html b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html new file mode 100644 index 0000000..c00b111 --- /dev/null +++ b/apidocs/com/amazon/carbonado/raw/GzipCompressor.html @@ -0,0 +1,294 @@ + + + + + + +GzipCompressor (Carbonado 1.2.3 API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.amazon.carbonado.raw
+

Class GzipCompressor

+
+
+ +
+
    +
  • +
    +
    +
    public class GzipCompressor
+extends java.lang.Object
    +
    Raw-level data compression using gzip.
    +
    Author:
    +
    Olga Kuznetsova, Brian S O'Neill
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      GzipCompressor() 
      +
      • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static byte[]compress(byte[] value, + int prefix) +
      Encodes into compressed form.
      +
      static byte[]decompress(byte[] value, + int prefix) +
      Decodes from compressed form.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GzipCompressor

        +
        public GzipCompressor()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compress

        +
        public static byte[] compress(byte[] value,
+              int prefix)
+                       throws SupportException
        +
        Encodes into compressed form.
        +
        Parameters:
        value - value to compress
        prefix - prefix of byte array to preserve
        +
        Returns:
        compressed value
        +
        Throws:
        +
        SupportException - thrown if compression failed
        +
        • +
      + + + +
        +
      • +

        decompress

        +
        public static byte[] decompress(byte[] value,
+                int prefix)
+                         throws CorruptEncodingException
        +
        Decodes from compressed form.
        +
        Parameters:
        value - value to decompress
        prefix - prefix of byte array to preserve
        +
        Returns:
        decompressed value
        +
        Throws:
        +
        CorruptEncodingException - thrown if value cannot be decompressed
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ +

Copyright © 2006-2013 Amazon Technologies, Inc.. All Rights Reserved.

+ + -- cgit v1.2.3