ceph/src/arrow/java/vector/src/main/java/org/apache/arrow/vector/compression/CompressionCodec.java

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  *    http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 package org.apache.arrow.vector.compression;
  19
  20 import org.apache.arrow.memory.ArrowBuf;
  21 import org.apache.arrow.memory.BufferAllocator;
  22
  23 /**
  24  * The codec for compression/decompression.
  25  */
  26 public interface CompressionCodec {
  27
  28   /**
  29    * Compress a buffer.
  30    * @param allocator the allocator for allocating memory for compressed buffer.
  31    * @param uncompressedBuffer the buffer to compress.
  32    *                           Implementation of this method should take care of releasing this buffer.
  33    * @return the compressed buffer
  34    */
  35   ArrowBuf compress(BufferAllocator allocator, ArrowBuf uncompressedBuffer);
  36
  37   /**
  38    * Decompress a buffer.
  39    * @param allocator the allocator for allocating memory for decompressed buffer.
  40    * @param compressedBuffer the buffer to be decompressed.
  41    *                         Implementation of this method should take care of releasing this buffer.
  42    * @return the decompressed buffer.
  43    */
  44   ArrowBuf decompress(BufferAllocator allocator, ArrowBuf compressedBuffer);
  45
  46   /**
  47    * Gets the type of the codec.
  48    * @return the type of the codec.
  49    */
  50   CompressionUtil.CodecType getCodecType();
  51
  52   /**
  53    * Factory to create compression codec.
  54    */
  55   interface Factory {
  56
  57     /**
  58      * Creates the codec based on the codec type.
  59      */
  60     CompressionCodec createCodec(CompressionUtil.CodecType codecType);
  61   }
  62 }