Package ome.codecs

Class ZstdCodec

  • All Implemented Interfaces:
    Codec
    public class ZstdCodec
extends BaseCodec
    This class implements Zstandard decompression.
    Author:
    Wim Pomp w.pomp at nki.nl

    • Constructor Summary

      Constructors 
      Constructor Description
      ZstdCodec()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte[] compress​(byte[] data, CodecOptions options)
      Compresses a block of data.
      byte[] decompress​(byte[] data)
      Decompresses a block of data.
      byte[] decompress​(byte[] data, int inputOffset, int length)
      Decompresses a block of data of specified length from an initial offset.
      byte[] decompress​(byte[] data, CodecOptions options)
      Decompresses a block of data.
      byte[] decompress​(loci.common.RandomAccessInputStream in, CodecOptions options)
      Decompresses data from the given RandomAccessInputStream.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ZstdCodec

        public ZstdCodec()

    • Method Detail

      • compress

        public byte[] compress​(byte[] data,
                       CodecOptions options)
                throws CodecException
        Description copied from interface: Codec
        Compresses a block of data.
        Parameters:
        data - The data to be compressed.
        options - Options to be used during compression, if appropriate.
        Returns:
        The compressed data.
        Throws:
        CodecException - If input is not a compressed data block of the appropriate type.

      • decompress

        public byte[] decompress​(loci.common.RandomAccessInputStream in,
                         CodecOptions options)
                  throws CodecException,
                         java.io.IOException
        Description copied from interface: Codec
        Decompresses data from the given RandomAccessInputStream.
        Specified by:
        decompress in interface Codec
        Specified by:
        decompress in class BaseCodec
        Parameters:
        in - The stream from which to read compressed data.
        options - Options to be used during decompression.
        Returns:
        The decompressed data.
        Throws:
        CodecException - If data is not valid compressed data for this decompressor.
        java.io.IOException

      • decompress

        public byte[] decompress​(byte[] data)
                  throws CodecException
        Description copied from interface: Codec
        Decompresses a block of data.
        Specified by:
        decompress in interface Codec
        Overrides:
        decompress in class BaseCodec
        Parameters:
        data - the data to be decompressed.
        Returns:
        The decompressed data.
        Throws:
        CodecException - If data is not valid compressed data for this decompressor.

      • decompress

        public byte[] decompress​(byte[] data,
                         CodecOptions options)
                  throws CodecException
        Description copied from interface: Codec
        Decompresses a block of data.
        Specified by:
        decompress in interface Codec
        Overrides:
        decompress in class BaseCodec
        Parameters:
        data - the data to be decompressed
        options - Options to be used during decompression.
        Returns:
        the decompressed data.
        Throws:
        CodecException - If data is not valid.

      • decompress

        public byte[] decompress​(byte[] data,
                         int inputOffset,
                         int length)
                  throws CodecException
        Decompresses a block of data of specified length from an initial offset.
        Parameters:
        data - The data to be decompressed.
        inputOffset - The position of the input data at which to begin decompression.
        length - The length of input data to be decompressed.
        Returns:
        The decompressed data.
        Throws:
        CodecException - If data is not valid.