loci.formats.codec

Class PassthroughCodec

java.lang.Object

loci.formats.codec.BaseCodec

loci.formats.codec.PassthroughCodec

All Implemented Interfaces:

Codec

public class PassthroughCodec
extends BaseCodec

A codec which just returns the exact data it was given, performing no compression or decompression.

Field Summary

Fields inherited from class loci.formats.codec.BaseCodec

LOGGER

Constructor Summary

Constructors

Constructor and Description
PassthroughCodec()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	compress(byte[] data, CodecOptions options) Compresses a block of data.
byte[]	decompress(byte[] data, CodecOptions options) Decompresses a block of data.
byte[]	decompress(RandomAccessInputStream in, CodecOptions options) Decompresses data from the given RandomAccessInputStream.

Methods inherited from class loci.formats.codec.BaseCodec

compress, decompress, decompress, decompress, test

Methods inherited from class java.lang.Object

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

Constructor Detail

PassthroughCodec

public PassthroughCodec()

Method Detail

decompress

public byte[] decompress(byte[] data,
                CodecOptions options)
                  throws FormatException

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:

FormatException - If data is not valid.

decompress

public byte[] decompress(RandomAccessInputStream in,
                CodecOptions options)
                  throws FormatException,
                         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:

FormatException - If data is not valid compressed data for this decompressor.

IOException

compress

public byte[] compress(byte[] data,
              CodecOptions options)
                throws FormatException

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:

FormatException - If input is not a compressed data block of the appropriate type.