com.github.jaiimageio.impl.plugins.tiff

Class TIFFDeflater

java.lang.Object

com.github.jaiimageio.plugins.tiff.TIFFCompressor

com.github.jaiimageio.impl.plugins.tiff.TIFFDeflater

Direct Known Subclasses:

TIFFDeflateCompressor, TIFFZLibCompressor

public class TIFFDeflater
extends TIFFCompressor

Compressor superclass for Deflate and ZLib compression.

Field Summary

Fields inherited from class com.github.jaiimageio.plugins.tiff.TIFFCompressor

compressionTagValue, compressionType, isCompressionLossless, metadata, stream, writer

Constructor Summary

Constructors

Constructor and Description
TIFFDeflater(String compressionType, int compressionTagValue, ImageWriteParam param, int predictorValue)

Method Summary

Modifier and Type	Method and Description
void	dispose() Allows any resources held by this object to be released.
int	encode(byte[] b, int off, int width, int height, int[] bitsPerSample, int scanlineStride) Encodes the supplied image data, writing to the currently set ImageOutputStream.

Methods inherited from class com.github.jaiimageio.plugins.tiff.TIFFCompressor

getCompressionTagValue, getCompressionType, getMetadata, getStream, getWriter, isCompressionLossless, setMetadata, setStream, setWriter

Methods inherited from class java.lang.Object

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

Constructor Detail

TIFFDeflater

public TIFFDeflater(String compressionType,
                    int compressionTagValue,
                    ImageWriteParam param,
                    int predictorValue)

Method Detail

encode

public int encode(byte[] b,
                  int off,
                  int width,
                  int height,
                  int[] bitsPerSample,
                  int scanlineStride)
           throws IOException

Description copied from class: TIFFCompressor

Encodes the supplied image data, writing to the currently set ImageOutputStream.

Specified by:

encode in class TIFFCompressor

Parameters:

b - an array of bytes containing the packed but uncompressed image data.

off - the starting offset of the data to be written in the array b.

width - the width of the rectangle of pixels to be written.

height - the height of the rectangle of pixels to be written.

bitsPerSample - an array of ints indicting the number of bits used to represent each image sample within a pixel.

scanlineStride - the number of bytes separating each row of the input data.

Returns:

the number of bytes written.

Throws:

IOException - if the supplied data cannot be encoded by this TIFFCompressor, or if any I/O error occurs during writing.

dispose

public void dispose()

Description copied from class: TIFFCompressor

Allows any resources held by this object to be released. The result of calling any other method (other than finalize) subsequent to a call to this method is undefined.

It is important for applications to call this method when they know they will no longer be using this TIFFCompressor. Otherwise, the writer may continue to hold on to resources indefinitely.

The default implementation of this method in the superclass does nothing. Subclass implementations should ensure that all resources, especially native resources, are released.

Overrides:

dispose in class TIFFCompressor