OpenJDK 1.23 · com.sun.imageio.plugins.tiff.TIFFCompressor

Field Summary

Modifier and Type	Field and Description
protected int	compressionTagValue The value to be assigned to the TIFF Compression tag in the TIFF image metadata.
protected String	compressionType The name of the compression type supported by this compressor.
protected boolean	isCompressionLossless Whether the compression is lossless.
protected IIOMetadata	metadata The `IIOMetadata` object containing metadata for the current image.
protected ImageOutputStream	stream The `ImageOutputStream` to be written.
protected ImageWriter	writer The `ImageWriter` calling this `TIFFCompressor`.

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	TIFFCompressor(String The name of the compression type. compressionType, int The value to be assigned to the TIFF Compression tag in the TIFF image metadata; ignored if `compressionType` is a known type. compressionTagValue, boolean Whether the compression is lossless; ignored if `compressionType` is a known type. isCompressionLossless) Creates a compressor object for use in compressing TIFF data.

public

TIFFCompressor(String

The name of the compression type.

compressionType, int

The value to be assigned to the TIFF Compression tag in the TIFF image metadata; ignored if compressionType is a known type.

compressionTagValue, boolean

Whether the compression is lossless; ignored if compressionType is a known type.

isCompressionLossless)

Creates a compressor object for use in compressing TIFF data.

Method Summary

Modifier and Type	Method and Description
public abstract int	Returns: the number of bytes written. encode(byte[] an array of `byte`s containing the packed but uncompressed image data. b, int the starting offset of the data to be written in the array `b`. off, int the width of the rectangle of pixels to be written. width, int the height of the rectangle of pixels to be written. height, int[] an array of `int`s indicting the number of bits used to represent each image sample within a pixel. bitsPerSample, int the number of bytes separating each row of the input data. scanlineStride) Encodes the supplied image data, writing to the currently set `ImageOutputStream`.
public int	Returns: The Compression tag value. getCompressionTagValue() Retrieve the value to be assigned to the TIFF Compression tag in the TIFF image metadata.
public String	Returns: The compression type name. getCompressionType() Retrieve the name of the compression type supported by this compressor.
public IIOMetadata	Returns: the `IIOMetadata` object for the image being written. getMetadata() Returns the current `IIOMetadata` object.
public ImageOutputStream	Returns: an `ImageOutputStream`. getStream() Returns the `ImageOutputStream` that will be written.
public ImageWriter	Returns: an `ImageWriter`. getWriter() Returns the current `ImageWriter`.
public boolean	Returns: Whether the compression is lossless. isCompressionLossless() Retrieves a value indicating whether the compression is lossless.
public void	setMetadata(IIOMetadata the `IIOMetadata` object for the image being written. metadata) Sets the value of the `metadata` field.
public void	setStream(ImageOutputStream an `ImageOutputStream` to be written. stream) Sets the `ImageOutputStream` to be written.
public void	setWriter(ImageWriter the current `ImageWriter`. writer) Sets the value of the `writer` field.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

compressionTagValue	back to summary
protected int compressionTagValue The value to be assigned to the TIFF Compression tag in the TIFF image metadata.

compressionType	back to summary
protected String compressionType The name of the compression type supported by this compressor.

isCompressionLossless	back to summary
protected boolean isCompressionLossless Whether the compression is lossless.

metadata	back to summary
protected IIOMetadata metadata The `IIOMetadata` object containing metadata for the current image.

stream	back to summary
protected ImageOutputStream stream The `ImageOutputStream` to be written.

writer	back to summary
protected ImageWriter writer The `ImageWriter` calling this `TIFFCompressor`.

Constructor Detail

TIFFCompressor back to summary

TIFFCompressor	back to summary
public TIFFCompressor(String compressionType, int compressionTagValue, boolean isCompressionLossless) Creates a compressor object for use in compressing TIFF data. The parameters `compressionTagValue` and `isCompressionLossless` are provided to accommodate compression types which are unknown. A compression type is "known" if it is either among those already supported by the TIFF writer (see `TIFFImageWriteParam`), or is listed in the TIFF 6.0 specification but not supported. If the compression type is unknown, the `compressionTagValue` and `isCompressionLossless` parameters are ignored. Parameters compressionType:String The name of the compression type. compressionTagValue:int The value to be assigned to the TIFF Compression tag in the TIFF image metadata; ignored if `compressionType` is a known type. isCompressionLossless:boolean Whether the compression is lossless; ignored if `compressionType` is a known type. Exceptions NullPointerException: if `compressionType` is `null`. IllegalArgumentException: if `compressionTagValue` is less `1`.

public TIFFCompressor(String compressionType, int compressionTagValue, boolean isCompressionLossless)

Creates a compressor object for use in compressing TIFF data.

The parameters compressionTagValue and isCompressionLossless are provided to accommodate compression types which are unknown. A compression type is "known" if it is either among those already supported by the TIFF writer (see TIFFImageWriteParam), or is listed in the TIFF 6.0 specification but not supported. If the compression type is unknown, the compressionTagValue and isCompressionLossless parameters are ignored.

Parameters

compressionType:String: The name of the compression type.
compressionTagValue:int: The value to be assigned to the TIFF Compression tag in the TIFF image metadata; ignored if compressionType is a known type.
isCompressionLossless:boolean: Whether the compression is lossless; ignored if compressionType is a known type.

Exceptions

NullPointerException:: if compressionType is null.
IllegalArgumentException:: if compressionTagValue is less 1.

Method Detail

encode back to summary

encode	back to summary
public abstract int encode(byte[] b, int off, int width, int height, int[] bitsPerSample, int scanlineStride) throws IOException Encodes the supplied image data, writing to the currently set `ImageOutputStream`. Parameters b:byte[] an array of `byte`s containing the packed but uncompressed image data. off:int the starting offset of the data to be written in the array `b`. width:int the width of the rectangle of pixels to be written. height:int the height of the rectangle of pixels to be written. bitsPerSample:int[] an array of `int`s indicting the number of bits used to represent each image sample within a pixel. scanlineStride:int the number of bytes separating each row of the input data. Returns:int the number of bytes written. Exceptions IOException: if the supplied data cannot be encoded by this `TIFFCompressor`, or if any I/O error occurs during writing.

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

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

Parameters

b:byte[]: an array of bytes containing the packed but uncompressed image data.
off:int: the starting offset of the data to be written in the array b.
width:int: the width of the rectangle of pixels to be written.
height:int: the height of the rectangle of pixels to be written.
bitsPerSample:int[]: an array of ints indicting the number of bits used to represent each image sample within a pixel.
scanlineStride:int: the number of bytes separating each row of the input data.

Returns:int

the number of bytes written.

Exceptions

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

getCompressionTagValue	back to summary
public int getCompressionTagValue() Retrieve the value to be assigned to the TIFF Compression tag in the TIFF image metadata. Returns:int The Compression tag value.

getCompressionTagValue

back to summary

public int getCompressionTagValue()

Retrieve the value to be assigned to the TIFF Compression tag in the TIFF image metadata.

Returns:int: The Compression tag value.

getCompressionType	back to summary
public String getCompressionType() Retrieve the name of the compression type supported by this compressor. Returns:String The compression type name.

getCompressionType

back to summary

public String getCompressionType()

Retrieve the name of the compression type supported by this compressor.

Returns:String: The compression type name.

getMetadata back to summary

public IIOMetadata getMetadata()

Returns the current IIOMetadata object.

Returns:IIOMetadata: the IIOMetadata object for the image being written.
See Also: setMetadata(IIOMetadata)

getStream back to summary

getStream	back to summary
public ImageOutputStream getStream() Returns the `ImageOutputStream` that will be written. Returns:ImageOutputStream an `ImageOutputStream`. See Also `setStream(ImageOutputStream)`

public ImageOutputStream getStream()

Returns the ImageOutputStream that will be written.

Returns:ImageOutputStream: an ImageOutputStream.
See Also: setStream(ImageOutputStream)

getWriter back to summary

getWriter	back to summary
public ImageWriter getWriter() Returns the current `ImageWriter`. Returns:ImageWriter an `ImageWriter`. See Also `setWriter(ImageWriter)`

public ImageWriter getWriter()

Returns the current ImageWriter.

Returns:ImageWriter: an ImageWriter.
See Also: setWriter(ImageWriter)

isCompressionLossless	back to summary
public boolean isCompressionLossless() Retrieves a value indicating whether the compression is lossless. Returns:boolean Whether the compression is lossless.

isCompressionLossless

back to summary

public boolean isCompressionLossless()

Retrieves a value indicating whether the compression is lossless.

Returns:boolean: Whether the compression is lossless.

setMetadata back to summary

public void setMetadata(IIOMetadata metadata)

Sets the value of the metadata field.

Parameters

metadata:IIOMetadata: the IIOMetadata object for the image being written.

See Also

getMetadata()

setStream back to summary

setStream	back to summary
public void setStream(ImageOutputStream stream) Sets the `ImageOutputStream` to be written. Parameters stream:ImageOutputStream an `ImageOutputStream` to be written. See Also `getStream`

public void setStream(ImageOutputStream stream)

Sets the ImageOutputStream to be written.

Parameters

stream:ImageOutputStream: an ImageOutputStream to be written.

See Also

getStream

setWriter back to summary

setWriter	back to summary
public void setWriter(ImageWriter writer) Sets the value of the `writer` field. Parameters writer:ImageWriter the current `ImageWriter`. See Also `getWriter()`

public void setWriter(ImageWriter writer)

Sets the value of the writer field.

Parameters

writer:ImageWriter: the current ImageWriter.

See Also

getWriter()

public abstract Class TIFFCompressor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail