Class ImageIOUtil


  • public class ImageIOUtil
    extends java.lang.Object
    Handles some ImageIO operations.
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static boolean writeImage​(java.awt.image.BufferedImage image, java.lang.String filename, int dpi)
      Writes a buffered image to a file using the given image format.
      static boolean writeImage​(java.awt.image.BufferedImage image, java.lang.String formatName, java.io.OutputStream output)
      Writes a buffered image to a file using the given image format.
      static boolean writeImage​(java.awt.image.BufferedImage image, java.lang.String formatName, java.io.OutputStream output, int dpi)
      Writes a buffered image to a file using the given image format.
      static boolean writeImage​(java.awt.image.BufferedImage image, java.lang.String formatName, java.io.OutputStream output, int dpi, float quality)
      Writes a buffered image to a file using the given image format.
      static boolean writeImage​(java.awt.image.BufferedImage image, java.lang.String formatName, java.lang.String filename, int dpi)
      Deprecated.
      use writeImage(BufferedImage image, String filename, int dpi), which uses the full filename instead of just the prefix.
      • Methods inherited from class java.lang.Object

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

      • DEFAULT_SCREEN_RESOLUTION

        public static final int DEFAULT_SCREEN_RESOLUTION
        Default screen resolution: 72dpi.
        See Also:
        Constant Field Values
      • DEFAULT_COMPRESSION_QUALITY

        public static final float DEFAULT_COMPRESSION_QUALITY
        Default compression quality: 1.0f.
        See Also:
        Constant Field Values
    • Method Detail

      • writeImage

        public static boolean writeImage​(java.awt.image.BufferedImage image,
                                         java.lang.String filename,
                                         int dpi)
                                  throws java.io.IOException
        Writes a buffered image to a file using the given image format. See writeImage(BufferedImage image, String formatName, OutputStream output, int dpi, float quality) for more details.
        Parameters:
        image - the image to be written
        filename - used to construct the filename for the individual image. Its suffix will be used as the image format.
        dpi - the resolution in dpi (dots per inch)
        Returns:
        true if the image file was produced, false if there was an error.
        Throws:
        java.io.IOException - if an I/O error occurs
      • writeImage

        @Deprecated
        public static boolean writeImage​(java.awt.image.BufferedImage image,
                                         java.lang.String formatName,
                                         java.lang.String filename,
                                         int dpi)
                                  throws java.io.IOException
        Deprecated.
        use writeImage(BufferedImage image, String filename, int dpi), which uses the full filename instead of just the prefix.
        Writes a buffered image to a file using the given image format. See writeImage(BufferedImage image, String formatName, OutputStream output, int dpi, float quality) for more details.
        Parameters:
        image - the image to be written
        formatName - the target format (ex. "png") which is also the suffix for the filename
        filename - used to construct the filename for the individual image. The formatName parameter will be used as the suffix.
        dpi - the resolution in dpi (dots per inch)
        Returns:
        true if the image file was produced, false if there was an error.
        Throws:
        java.io.IOException - if an I/O error occurs
      • writeImage

        public static boolean writeImage​(java.awt.image.BufferedImage image,
                                         java.lang.String formatName,
                                         java.io.OutputStream output)
                                  throws java.io.IOException
        Writes a buffered image to a file using the given image format. See writeImage(BufferedImage image, String formatName, OutputStream output, int dpi, float quality) for more details.
        Parameters:
        image - the image to be written
        formatName - the target format (ex. "png")
        output - the output stream to be used for writing
        Returns:
        true if the image file was produced, false if there was an error.
        Throws:
        java.io.IOException - if an I/O error occurs
      • writeImage

        public static boolean writeImage​(java.awt.image.BufferedImage image,
                                         java.lang.String formatName,
                                         java.io.OutputStream output,
                                         int dpi)
                                  throws java.io.IOException
        Writes a buffered image to a file using the given image format. See writeImage(BufferedImage image, String formatName, OutputStream output, int dpi, float quality) for more details.
        Parameters:
        image - the image to be written
        formatName - the target format (ex. "png")
        output - the output stream to be used for writing
        dpi - resolution to be used when writing the image
        Returns:
        true if the image file was produced, false if there was an error.
        Throws:
        java.io.IOException - if an I/O error occurs
      • writeImage

        public static boolean writeImage​(java.awt.image.BufferedImage image,
                                         java.lang.String formatName,
                                         java.io.OutputStream output,
                                         int dpi,
                                         float quality)
                                  throws java.io.IOException
        Writes a buffered image to a file using the given image format. Compression is fixed for PNG, GIF, BMP and WBMP, dependent of the quality parameter for JPG, and dependent of bit count for TIFF (a bitonal image will be compressed with CCITT G4, a color image with LZW). Creating a TIFF image is only supported if the jai_imageio library is in the class path.
        Parameters:
        image - the image to be written
        formatName - the target format (ex. "png")
        output - the output stream to be used for writing
        dpi - resolution to be used when writing the image
        quality - quality to be used when compressing the image (0 < quality < 1.0f)
        Returns:
        true if the image file was produced, false if there was an error.
        Throws:
        java.io.IOException - if an I/O error occurs