Class TIFFImageWriter

  • All Implemented Interfaces:
    javax.imageio.ImageTranscoder

    public class TIFFImageWriter
    extends javax.imageio.ImageWriter
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int[] compressionNumbers
      Compression tag values for known compression types.
      static java.lang.String[] compressionTypes
      Known TIFF compression types.
      static int DEFAULT_BYTES_PER_STRIP  
      static boolean[] isCompressionLossless
      Lossless flag for known compression types.
      static java.lang.String[] TIFFCompressionTypes
      Supported TIFF compression types.
      • Fields inherited from class javax.imageio.ImageWriter

        availableLocales, locale, originatingProvider, output, progressListeners, warningListeners, warningLocales
    • Constructor Summary

      Constructors 
      Constructor Description
      TIFFImageWriter​(javax.imageio.spi.ImageWriterSpi originatingProvider)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canInsertEmpty​(int imageIndex)  
      boolean canInsertImage​(int imageIndex)  
      boolean canReplacePixels​(int imageIndex)  
      boolean canWriteEmpty()  
      boolean canWriteSequence()  
      javax.imageio.metadata.IIOMetadata convertImageMetadata​(javax.imageio.metadata.IIOMetadata inData, javax.imageio.ImageTypeSpecifier imageType, javax.imageio.ImageWriteParam param)  
      javax.imageio.metadata.IIOMetadata convertStreamMetadata​(javax.imageio.metadata.IIOMetadata inData, javax.imageio.ImageWriteParam param)  
      void dispose()  
      void endInsertEmpty()  
      void endReplacePixels()  
      void endWriteEmpty()  
      void endWriteSequence()  
      javax.imageio.metadata.IIOMetadata getDefaultImageMetadata​(javax.imageio.ImageTypeSpecifier imageType, javax.imageio.ImageWriteParam param)  
      javax.imageio.metadata.IIOMetadata getDefaultStreamMetadata​(javax.imageio.ImageWriteParam param)  
      javax.imageio.ImageWriteParam getDefaultWriteParam()  
      void prepareInsertEmpty​(int imageIndex, javax.imageio.ImageTypeSpecifier imageType, int width, int height, javax.imageio.metadata.IIOMetadata imageMetadata, java.util.List thumbnails, javax.imageio.ImageWriteParam param)  
      void prepareReplacePixels​(int imageIndex, java.awt.Rectangle region)  
      void prepareWriteEmpty​(javax.imageio.metadata.IIOMetadata streamMetadata, javax.imageio.ImageTypeSpecifier imageType, int width, int height, javax.imageio.metadata.IIOMetadata imageMetadata, java.util.List thumbnails, javax.imageio.ImageWriteParam param)  
      void prepareWriteSequence​(javax.imageio.metadata.IIOMetadata streamMetadata)  
      void replacePixels​(java.awt.image.Raster raster, javax.imageio.ImageWriteParam param)  
      void replacePixels​(java.awt.image.RenderedImage image, javax.imageio.ImageWriteParam param)  
      void reset()  
      void setOutput​(java.lang.Object output)  
      void write​(javax.imageio.metadata.IIOMetadata sm, javax.imageio.IIOImage iioimage, javax.imageio.ImageWriteParam p)  
      void writeInsert​(int imageIndex, javax.imageio.IIOImage image, javax.imageio.ImageWriteParam param)  
      void writeToSequence​(javax.imageio.IIOImage image, javax.imageio.ImageWriteParam param)  
      static int XToTileX​(int x, int tileGridXOffset, int tileWidth)
      Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.
      static int YToTileY​(int y, int tileGridYOffset, int tileHeight)
      Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.
      • Methods inherited from class javax.imageio.ImageWriter

        abort, abortRequested, addIIOWriteProgressListener, addIIOWriteWarningListener, canRemoveImage, canReplaceImageMetadata, canReplaceStreamMetadata, canWriteRasters, clearAbortRequest, getAvailableLocales, getLocale, getNumThumbnailsSupported, getOriginatingProvider, getOutput, getPreferredThumbnailSizes, processImageComplete, processImageProgress, processImageStarted, processThumbnailComplete, processThumbnailProgress, processThumbnailStarted, processWarningOccurred, processWarningOccurred, processWriteAborted, removeAllIIOWriteProgressListeners, removeAllIIOWriteWarningListeners, removeIIOWriteProgressListener, removeIIOWriteWarningListener, removeImage, replaceImageMetadata, replaceStreamMetadata, setLocale, write, write
      • Methods inherited from class java.lang.Object

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

      • DEFAULT_BYTES_PER_STRIP

        public static final int DEFAULT_BYTES_PER_STRIP
        See Also:
        Constant Field Values
      • TIFFCompressionTypes

        public static final java.lang.String[] TIFFCompressionTypes
        Supported TIFF compression types.
      • compressionTypes

        public static final java.lang.String[] compressionTypes
        Known TIFF compression types.
      • isCompressionLossless

        public static final boolean[] isCompressionLossless
        Lossless flag for known compression types.
      • compressionNumbers

        public static final int[] compressionNumbers
        Compression tag values for known compression types.
    • Constructor Detail

      • TIFFImageWriter

        public TIFFImageWriter​(javax.imageio.spi.ImageWriterSpi originatingProvider)
    • Method Detail

      • XToTileX

        public static int XToTileX​(int x,
                                   int tileGridXOffset,
                                   int tileWidth)
        Converts a pixel's X coordinate into a horizontal tile index relative to a given tile grid layout specified by its X offset and tile width.

        If tileWidth < 0, the results of this method are undefined. If tileWidth == 0, an ArithmeticException will be thrown.

        Throws:
        java.lang.ArithmeticException - If tileWidth == 0.
      • YToTileY

        public static int YToTileY​(int y,
                                   int tileGridYOffset,
                                   int tileHeight)
        Converts a pixel's Y coordinate into a vertical tile index relative to a given tile grid layout specified by its Y offset and tile height.

        If tileHeight < 0, the results of this method are undefined. If tileHeight == 0, an ArithmeticException will be thrown.

        Throws:
        java.lang.ArithmeticException - If tileHeight == 0.
      • getDefaultWriteParam

        public javax.imageio.ImageWriteParam getDefaultWriteParam()
        Overrides:
        getDefaultWriteParam in class javax.imageio.ImageWriter
      • setOutput

        public void setOutput​(java.lang.Object output)
        Overrides:
        setOutput in class javax.imageio.ImageWriter
      • getDefaultStreamMetadata

        public javax.imageio.metadata.IIOMetadata getDefaultStreamMetadata​(javax.imageio.ImageWriteParam param)
        Specified by:
        getDefaultStreamMetadata in class javax.imageio.ImageWriter
      • getDefaultImageMetadata

        public javax.imageio.metadata.IIOMetadata getDefaultImageMetadata​(javax.imageio.ImageTypeSpecifier imageType,
                                                                          javax.imageio.ImageWriteParam param)
        Specified by:
        getDefaultImageMetadata in class javax.imageio.ImageWriter
      • convertStreamMetadata

        public javax.imageio.metadata.IIOMetadata convertStreamMetadata​(javax.imageio.metadata.IIOMetadata inData,
                                                                        javax.imageio.ImageWriteParam param)
        Specified by:
        convertStreamMetadata in interface javax.imageio.ImageTranscoder
        Specified by:
        convertStreamMetadata in class javax.imageio.ImageWriter
      • convertImageMetadata

        public javax.imageio.metadata.IIOMetadata convertImageMetadata​(javax.imageio.metadata.IIOMetadata inData,
                                                                       javax.imageio.ImageTypeSpecifier imageType,
                                                                       javax.imageio.ImageWriteParam param)
        Specified by:
        convertImageMetadata in interface javax.imageio.ImageTranscoder
        Specified by:
        convertImageMetadata in class javax.imageio.ImageWriter
      • write

        public void write​(javax.imageio.metadata.IIOMetadata sm,
                          javax.imageio.IIOImage iioimage,
                          javax.imageio.ImageWriteParam p)
                   throws java.io.IOException
        Specified by:
        write in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • canWriteSequence

        public boolean canWriteSequence()
        Overrides:
        canWriteSequence in class javax.imageio.ImageWriter
      • prepareWriteSequence

        public void prepareWriteSequence​(javax.imageio.metadata.IIOMetadata streamMetadata)
                                  throws java.io.IOException
        Overrides:
        prepareWriteSequence in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • writeToSequence

        public void writeToSequence​(javax.imageio.IIOImage image,
                                    javax.imageio.ImageWriteParam param)
                             throws java.io.IOException
        Overrides:
        writeToSequence in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • endWriteSequence

        public void endWriteSequence()
                              throws java.io.IOException
        Overrides:
        endWriteSequence in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • canInsertImage

        public boolean canInsertImage​(int imageIndex)
                               throws java.io.IOException
        Overrides:
        canInsertImage in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • writeInsert

        public void writeInsert​(int imageIndex,
                                javax.imageio.IIOImage image,
                                javax.imageio.ImageWriteParam param)
                         throws java.io.IOException
        Overrides:
        writeInsert in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • canInsertEmpty

        public boolean canInsertEmpty​(int imageIndex)
                               throws java.io.IOException
        Overrides:
        canInsertEmpty in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • canWriteEmpty

        public boolean canWriteEmpty()
                              throws java.io.IOException
        Overrides:
        canWriteEmpty in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • prepareInsertEmpty

        public void prepareInsertEmpty​(int imageIndex,
                                       javax.imageio.ImageTypeSpecifier imageType,
                                       int width,
                                       int height,
                                       javax.imageio.metadata.IIOMetadata imageMetadata,
                                       java.util.List thumbnails,
                                       javax.imageio.ImageWriteParam param)
                                throws java.io.IOException
        Overrides:
        prepareInsertEmpty in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • prepareWriteEmpty

        public void prepareWriteEmpty​(javax.imageio.metadata.IIOMetadata streamMetadata,
                                      javax.imageio.ImageTypeSpecifier imageType,
                                      int width,
                                      int height,
                                      javax.imageio.metadata.IIOMetadata imageMetadata,
                                      java.util.List thumbnails,
                                      javax.imageio.ImageWriteParam param)
                               throws java.io.IOException
        Overrides:
        prepareWriteEmpty in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • endInsertEmpty

        public void endInsertEmpty()
                            throws java.io.IOException
        Overrides:
        endInsertEmpty in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • endWriteEmpty

        public void endWriteEmpty()
                           throws java.io.IOException
        Overrides:
        endWriteEmpty in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • canReplacePixels

        public boolean canReplacePixels​(int imageIndex)
                                 throws java.io.IOException
        Overrides:
        canReplacePixels in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • prepareReplacePixels

        public void prepareReplacePixels​(int imageIndex,
                                         java.awt.Rectangle region)
                                  throws java.io.IOException
        Overrides:
        prepareReplacePixels in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • replacePixels

        public void replacePixels​(java.awt.image.RenderedImage image,
                                  javax.imageio.ImageWriteParam param)
                           throws java.io.IOException
        Overrides:
        replacePixels in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • replacePixels

        public void replacePixels​(java.awt.image.Raster raster,
                                  javax.imageio.ImageWriteParam param)
                           throws java.io.IOException
        Overrides:
        replacePixels in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • endReplacePixels

        public void endReplacePixels()
                              throws java.io.IOException
        Overrides:
        endReplacePixels in class javax.imageio.ImageWriter
        Throws:
        java.io.IOException
      • reset

        public void reset()
        Overrides:
        reset in class javax.imageio.ImageWriter
      • dispose

        public void dispose()
        Overrides:
        dispose in class javax.imageio.ImageWriter