javax.imageio

Interface ImageTranscoder

All Known Implementing Classes:

ImageWriter

public interface ImageTranscoder

An ImageTranscoder translates IIOMetadata objects provided by an ImageReader into corresponding IIOMetadata objects that can be understood by a given ImageWriter. Usually an ImageWriter will implement ImageTranscoder directly in which case the conversion methods will return IIOMetadata objects appropriate for this ImageWriter. Independent transcoders are also allowed; they must have knowledge of both the source IIOMetadata provided by the reader and the returned IIOMetadata expected by the writer.

Method Summary

Methods

Modifier and Type	Method and Description
javax.imageio.metadata.IIOMetadata	convertImageMetadata(javax.imageio.metadata.IIOMetadata inData, ImageTypeSpecifier imageType, ImageWriteParam param) Converts IIOMetadata from an input reader format, returning an IIOMetadata suitable for use by an image writer.
javax.imageio.metadata.IIOMetadata	convertStreamMetadata(javax.imageio.metadata.IIOMetadata inData, ImageWriteParam param) Converts IIOMetadata from an input stream format, returning an IIOMetadata suitable for use by an image writer.

Method Detail

convertImageMetadata

javax.imageio.metadata.IIOMetadata convertImageMetadata(javax.imageio.metadata.IIOMetadata inData,
                                                      ImageTypeSpecifier imageType,
                                                      ImageWriteParam param)

Converts IIOMetadata from an input reader format, returning an IIOMetadata suitable for use by an image writer. The ImageTypeSpecifier specifies the destination image type. An optional ImageWriteParam argument is available in case the image writing parameters affect the metadata conversion.

Parameters:

inData - the metadata coming from an image reader

imageType - the output image type of the writer

param - the image writing parameters or null

Returns:

the converted metadata that should be used by the image writer, or null if this ImageTranscoder has no knowledge of the input metadata

Throws:

java.lang.IllegalArgumentException - if either inData or imageType is null

convertStreamMetadata

javax.imageio.metadata.IIOMetadata convertStreamMetadata(javax.imageio.metadata.IIOMetadata inData,
                                                       ImageWriteParam param)

Converts IIOMetadata from an input stream format, returning an IIOMetadata suitable for use by an image writer. An optional ImageWriteParam argument is available in case the image writing parameters affect the metadata conversion.

Parameters:

inData - the metadata coming from an input image stream

param - the image writing parameters or null

Returns:

the converted metadata that should be used by the image writer, or null if this ImageTranscoder has no knowledge of the input metadata

Throws:

java.lang.IllegalArgumentException - if inData is null