com.rabbitmq.stream.compression.CompressionCodec Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stream-client Show documentation

The RabbitMQ Stream Java client library allows Java applications to interface with RabbitMQ Stream.

The newest version!

// Copyright (c) 2020-2023 Broadcom. All Rights Reserved.
// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
//
// This software, the RabbitMQ Stream Java client library, is dual-licensed under the
// Mozilla Public License 2.0 ("MPL"), and the Apache License version 2 ("ASL").
// For the MPL, please see LICENSE-MPL-RabbitMQ. For the ASL,
// please see LICENSE-APACHE2.
//
// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
// either express or implied. See the LICENSE file for specific language governing
// rights and limitations of this software.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].
package com.rabbitmq.stream.compression;

import java.io.InputStream;
import java.io.OutputStream;

/** Codec to compress and decompress sub-entries. */
public interface CompressionCodec {

  /**
   * Provides the maximum compressed size from the source length.
   *
   * @param sourceLength size of plain, uncompressed data
   * @return maximum compressed size
   */
  int maxCompressedLength(int sourceLength);

  /**
   * Creates an {@link OutputStream} to compress data.
   *
   * @param target the stream where compressed data will end up
   * @return output stream to write plain data to
   */
  OutputStream compress(OutputStream target);

  /**
   * Creates an {@link InputStream} to read decompressed data from.
   *
   * @param source the stream to read compressed data from
   * @return input stream to read decompressed data from
   */
  InputStream decompress(InputStream source);

  /**
   * Return the code for this type of codec.
   *
   * @return compression code
   */
  byte code();
}