Class ImageIOTIFFImageWriter
java.lang.Object
org.apache.xmlgraphics.image.writer.imageio.ImageIOImageWriter
org.apache.xmlgraphics.image.writer.imageio.ImageIOTIFFImageWriter
- All Implemented Interfaces:
EventListener
,IIOWriteWarningListener
,ImageWriter
ImageWriter that encodes TIFF images using Image I/O.
- Version:
- $Id$
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final IIOMetadataNode
createMetadataField
(int number, String name) Utility function to create a base TIFFField node for TIFF metadata.static final IIOMetadataNode
createRationalMetadataNode
(int number, String name, String value) Utility to create a TIFFRational metadata child node of a TIFFRationals node for TIFF metadata.static final IIOMetadataNode
createShortMetadataNode
(int number, String name, String value) Utility to create a TIFFShort metadata child node of a TIFFShorts node for TIFF metadata.static final IIOMetadataNode
createShortMetadataNode
(int number, String name, String value, String description) Utility to create a TIFFShort metadata child node of a TIFFShorts node for TIFF metadata.protected IIOMetadata
createStreamMetadata
(ImageWriter writer, ImageWriteParam writeParam, ImageWriterParams params) Creates the stream metadata for image.protected IIOMetadata
updateMetadata
(RenderedImage image, IIOMetadata meta, ImageWriterParams params) Updates the metadata information based on the parameters to this writer.Methods inherited from class org.apache.xmlgraphics.image.writer.imageio.ImageIOImageWriter
createMultiImageWriter, getChildNode, getDefaultWriteParam, getMIMEType, isFunctional, supportsMultiImageWriter, warningOccurred, writeImage, writeImage
-
Constructor Details
-
ImageIOTIFFImageWriter
public ImageIOTIFFImageWriter()Main constructor.
-
-
Method Details
-
updateMetadata
protected IIOMetadata updateMetadata(RenderedImage image, IIOMetadata meta, ImageWriterParams params) Updates the metadata information based on the parameters to this writer.- Overrides:
updateMetadata
in classImageIOImageWriter
- Parameters:
image
- the current image being renderedmeta
- the metadataparams
- the parameters- Returns:
- the updated metadata
-
createShortMetadataNode
Utility to create a TIFFShort metadata child node of a TIFFShorts node for TIFF metadata.- Parameters:
number
- value of the number attribute of the TIFFieldname
- value of the name attribute of the TIFFFieldvalue
- value of the value attribute of the TIFFShort- Returns:
- the new metadata node
-
createShortMetadataNode
public static final IIOMetadataNode createShortMetadataNode(int number, String name, String value, String description) Utility to create a TIFFShort metadata child node of a TIFFShorts node for TIFF metadata.- Parameters:
number
- value of the number attribute of the TIFFieldname
- value of the name attribute of the TIFFFieldvalue
- value of the value attribute of the TIFFShortdescription
- value of the description attribute of the TIFFShort, ignored if null- Returns:
- the new metadata node
-
createRationalMetadataNode
public static final IIOMetadataNode createRationalMetadataNode(int number, String name, String value) Utility to create a TIFFRational metadata child node of a TIFFRationals node for TIFF metadata.- Parameters:
number
- value of the number attribute of the TIFFieldname
- value of the name attribute of the TIFFFieldvalue
- value of the value attribute of the TIFFRational- Returns:
- the new metadata node
-
createMetadataField
Utility function to create a base TIFFField node for TIFF metadata.- Parameters:
number
- value of the number attribute of the TIFFieldname
- value of the name attribute of the TIFFField- Returns:
- the new metadata node
-
createStreamMetadata
protected IIOMetadata createStreamMetadata(ImageWriter writer, ImageWriteParam writeParam, ImageWriterParams params) Creates the stream metadata for image. By default, this method returns null which causes the default stream metadata to be used. Subclasses can override this to supply special stream metadata (see TIFF for an example).- Overrides:
createStreamMetadata
in classImageIOImageWriter
- Parameters:
writer
- the image writewriteParam
- the ImageIO write parametersparams
- the ImageWriter write parameters- Returns:
- the stream metadata (or null if no special metadata needs to be produced)
-