Class ImageIOTIFFImageWriter
- java.lang.Object
-
- org.apache.xmlgraphics.image.writer.imageio.ImageIOImageWriter
-
- org.apache.xmlgraphics.image.writer.imageio.ImageIOTIFFImageWriter
-
- All Implemented Interfaces:
java.util.EventListener
,javax.imageio.event.IIOWriteWarningListener
,ImageWriter
public class ImageIOTIFFImageWriter extends ImageIOImageWriter
ImageWriter that encodes TIFF images using Image I/O.- Version:
- $Id: ImageIOTIFFImageWriter.java 1732018 2016-02-24 04:51:06Z gadams $
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
DENOMINATOR_CENTIMETER
private static java.lang.String
DENOMINATOR_INCH
private static java.lang.String
SUN_TIFF_NATIVE_FORMAT
private static java.lang.String
SUN_TIFF_NATIVE_STREAM_FORMAT
-
Constructor Summary
Constructors Constructor Description ImageIOTIFFImageWriter()
Main constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static javax.imageio.metadata.IIOMetadataNode
createMetadataField(int number, java.lang.String name)
Utility function to create a base TIFFField node for TIFF metadata.static javax.imageio.metadata.IIOMetadataNode
createRationalMetadataNode(int number, java.lang.String name, java.lang.String value)
Utility to create a TIFFRational metadata child node of a TIFFRationals node for TIFF metadata.private javax.imageio.metadata.IIOMetadataNode
createResolutionField(int number, java.lang.String name, java.lang.Integer resolution, ResolutionUnit unit)
private javax.imageio.metadata.IIOMetadataNode
createResolutionUnitField(ImageWriterParams params)
Generate a TIFFField for resolution unit based on the parameters.static javax.imageio.metadata.IIOMetadataNode
createShortMetadataNode(int number, java.lang.String name, java.lang.String value)
Utility to create a TIFFShort metadata child node of a TIFFShorts node for TIFF metadata.static javax.imageio.metadata.IIOMetadataNode
createShortMetadataNode(int number, java.lang.String name, java.lang.String value, java.lang.String description)
Utility to create a TIFFShort metadata child node of a TIFFShorts node for TIFF metadata.protected javax.imageio.metadata.IIOMetadata
createStreamMetadata(javax.imageio.ImageWriter writer, javax.imageio.ImageWriteParam writeParam, ImageWriterParams params)
Creates the stream metadata for image.protected javax.imageio.metadata.IIOMetadata
updateMetadata(java.awt.image.RenderedImage image, javax.imageio.metadata.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
-
-
-
-
Field Detail
-
SUN_TIFF_NATIVE_FORMAT
private static final java.lang.String SUN_TIFF_NATIVE_FORMAT
- See Also:
- Constant Field Values
-
SUN_TIFF_NATIVE_STREAM_FORMAT
private static final java.lang.String SUN_TIFF_NATIVE_STREAM_FORMAT
- See Also:
- Constant Field Values
-
DENOMINATOR_CENTIMETER
private static final java.lang.String DENOMINATOR_CENTIMETER
- See Also:
- Constant Field Values
-
DENOMINATOR_INCH
private static final java.lang.String DENOMINATOR_INCH
- See Also:
- Constant Field Values
-
-
Method Detail
-
updateMetadata
protected javax.imageio.metadata.IIOMetadata updateMetadata(java.awt.image.RenderedImage image, javax.imageio.metadata.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
-
createResolutionField
private javax.imageio.metadata.IIOMetadataNode createResolutionField(int number, java.lang.String name, java.lang.Integer resolution, ResolutionUnit unit)
-
createResolutionUnitField
private javax.imageio.metadata.IIOMetadataNode createResolutionUnitField(ImageWriterParams params)
Generate a TIFFField for resolution unit based on the parameters.- Parameters:
params
-- Returns:
- the new metadata node
-
createShortMetadataNode
public static final javax.imageio.metadata.IIOMetadataNode createShortMetadataNode(int number, java.lang.String name, java.lang.String value)
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 javax.imageio.metadata.IIOMetadataNode createShortMetadataNode(int number, java.lang.String name, java.lang.String value, java.lang.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 javax.imageio.metadata.IIOMetadataNode createRationalMetadataNode(int number, java.lang.String name, java.lang.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
public static final javax.imageio.metadata.IIOMetadataNode createMetadataField(int number, java.lang.String name)
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 javax.imageio.metadata.IIOMetadata createStreamMetadata(javax.imageio.ImageWriter writer, javax.imageio.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)
-
-