org.janelia.saalfeldlab.n5.codec

Interface DataCodec

All Known Subinterfaces:

Compression, DeterministicSizeDataCodec

All Known Implementing Classes:

Bzip2Compression, ChecksumCodec, Crc32cChecksumCodec, GzipCompression, IdentityCodec, Lz4Compression, RawCompression, XzCompression

public interface DataCodec

DataCodecs transform one ReadData into another, for example, compressing it.

Method Summary

Modifier and Type	Method and Description
static DataCodec	concatenate(DataCodec... codecs) Create a DataCodec that sequentially applies codecs in the given order for encoding, and in reverse order for decoding.
static DataCodec	create(DataCodecInfo... codecInfos)
ReadData	decode(ReadData readData) Decode the given ReadData.
ReadData	encode(ReadData readData) Encode the given ReadData.

Method Detail

decode

ReadData decode(ReadData readData)
         throws N5Exception.N5IOException

Decode the given ReadData.

The returned decoded ReadData reports length()== decodedLength. Decoding may be lazy or eager, depending on the DataCodec implementation.

Parameters:

readData - data to decode

Returns:

decoded ReadData

Throws:

N5Exception.N5IOException - if any I/O error occurs

encode

ReadData encode(ReadData readData)
         throws N5Exception.N5IOException

Encode the given ReadData.

Encoding may be lazy or eager, depending on the DataCodec implementation.

Parameters:

readData - data to encode

Returns:

encoded ReadData

Throws:

N5Exception.N5IOException - if any I/O error occurs

concatenate

static DataCodec concatenate(DataCodec... codecs)

Create a DataCodec that sequentially applies codecs in the given order for encoding, and in reverse order for decoding.

If all codecs implement DeterministicSizeDataCodec, the returned DataCodec will also be a DeterministicSizeDataCodec.

Parameters:

codecs - a list of DataCodecs

Returns:

the concatenated DataCodec

create

static DataCodec create(DataCodecInfo... codecInfos)