Class 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 1833700 2018-06-18 10:08:45Z ssteiner $
    • 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.
      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 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ImageIOTIFFImageWriter

        public ImageIOTIFFImageWriter()
        Main constructor.
    • 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 class ImageIOImageWriter
        Parameters:
        image - the current image being rendered
        meta - the metadata
        params - the parameters
        Returns:
        the updated metadata
      • 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 TIFField
        name - value of the name attribute of the TIFFField
        value - 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 TIFField
        name - value of the name attribute of the TIFFField
        value - value of the value attribute of the TIFFShort
        description - 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 TIFField
        name - value of the name attribute of the TIFFField
        value - 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 TIFField
        name - 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 class ImageIOImageWriter
        Parameters:
        writer - the image write
        writeParam - the ImageIO write parameters
        params - the ImageWriter write parameters
        Returns:
        the stream metadata (or null if no special metadata needs to be produced)