to.etc.sjit

Class ImaTool

java.lang.Object

to.etc.sjit.ImaTool

public class ImaTool
extends Object

This static utility class has a lot of image-related helper functions.

Author:

Frits Jalvingh

Method Summary

Modifier and Type	Method and Description
static BufferedImage	awtLoadBufferedImage(File f) Loads the image from the file into an image.
static Image	awtLoadImage(File f) Loads the image from the file into an image.
static BufferedImage	awtResize(BufferedImage bi, int w, int h) Resizes a BufferedImage while keeping it's aspect ratio, using the AWT mechanism...
static double	findQualityBySize(BufferedImage bi, int sizenear) Taking a BufferedImage, this function will try to find a JPEG quality factor that will save the image with a size around the size specified.
static Dimension	getImageDimension(File resourceFile)
static Dimension	getImageDimension(InputStream is)
static Image	loadFile_image(File f) Loads an image from a file.
static BufferedImage	loadFile(File f) Loads an image from a file.
static BufferedImage	loadGIF(File f) Load a GIF format image using the BYTE_TYPE_INDEXED format (fastest)
static BufferedImage	loadGIF(File f, int buffertype) Load a GIF format image.
static BufferedImage	loadGIF(InputStream is) Load a GIF format image using the BYTE_TYPE_INDEXED format (fastest)
static BufferedImage	loadGIF(InputStream is, int buffertype) Load a GIF format image.
static BufferedImage	loadJPEG(File f) Loads a JPEG image from a file.
static BufferedImage	loadJPEG(InputStream is) Loads a JPEG image from a stream.
static BufferedImage	loadPNG(InputStream is)
static BufferedImage	loadStream(InputStream is, String type) Loads an image from a stream.
static void	main(String[] args)
static BufferedImage	makeBuffered(Image i) Converts an Image into a same-size buffered image if it's not already a BufferedImage.
static BufferedImage	makeBuffered(Image i, int bit) Converts an Image into a same-size buffered image if it's not already a BufferedImage.
static BufferedImage	resizeFiltered_RAW(BufferedImage i, int w, int h)
static BufferedImage	resizeFiltered_RAW(BufferedImage bi, int w, int h, ResamplerFilter fil)
static BufferedImage	resizeFiltered(BufferedImage i, int w, int h) Resizes a BufferedImage while keeping it's aspect ratio, using the optimal filtered stuff...
static BufferedImage	resizeFiltered(BufferedImage bi, int w, int h, ResamplerFilter fil) Resizes a BufferedImage while keeping it's aspect ratio, using the optimal filtered stuff...
static Dimension	resizeWithAspect(Dimension dest, Dimension src)
static Dimension	resizeWithAspect(int dw, int dh, int sw, int sh) Does a resize of an object with size (sw, sh) to fit within a rectangle of (dw, dh) while keeping the same aspect ratio
static void	saveGIF(BufferedImage bi, File f) Saves an image as a GIF file to a stream.
static void	saveGIF(BufferedImage bi, OutputStream os) Saves an image as a GIF file to a stream.
static void	saveImageByMime(OutputStream os, BufferedImage bi, String mime)
static void	saveJPEG(BufferedImage bi, File f, double qf) Saves an image as a JPEG to the stream specified, with the quality spec'd.
static void	saveJPEG(BufferedImage bi, OutputStream os, double qf) Saves an image as a JPEG to the stream specified, with the quality spec'd.
static void	savePNG(BufferedImage bi, File f)
static void	savePNG(BufferedImage bi, OutputStream f)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

resizeWithAspect

public static Dimension resizeWithAspect(int dw,
                                         int dh,
                                         int sw,
                                         int sh)

Does a resize of an object with size (sw, sh) to fit within a rectangle of (dw, dh) while keeping the same aspect ratio

resizeWithAspect

public static Dimension resizeWithAspect(Dimension dest,
                                         Dimension src)

makeBuffered

public static BufferedImage makeBuffered(Image i,
                                         int bit)

Converts an Image into a same-size buffered image if it's not already a BufferedImage.

makeBuffered

public static BufferedImage makeBuffered(Image i)

Converts an Image into a same-size buffered image if it's not already a BufferedImage.

loadPNG

public static BufferedImage loadPNG(InputStream is)
                             throws IOException

Throws:

IOException

loadJPEG

public static BufferedImage loadJPEG(InputStream is)
                              throws IOException

Loads a JPEG image from a stream. The image is returned as a BufferedImage.

Throws:

IOException

loadJPEG

public static BufferedImage loadJPEG(File f)
                              throws IOException

Loads a JPEG image from a file. The image is returned as a BufferedImage.

Throws:

IOException

saveJPEG

public static void saveJPEG(BufferedImage bi,
                            OutputStream os,
                            double qf)
                     throws IOException

Saves an image as a JPEG to the stream specified, with the quality spec'd. If q is zero the default quality will be used.

Throws:

IOException

saveJPEG

public static void saveJPEG(BufferedImage bi,
                            File f,
                            double qf)
                     throws IOException

Saves an image as a JPEG to the stream specified, with the quality spec'd. If q is zero the default quality will be used.

Throws:

IOException

loadGIF

public static BufferedImage loadGIF(File f,
                                    int buffertype)
                             throws IOException

Load a GIF format image.

Throws:

IOException

loadGIF

public static BufferedImage loadGIF(InputStream is,
                                    int buffertype)
                             throws IOException

Load a GIF format image.

Throws:

IOException

loadGIF

public static BufferedImage loadGIF(InputStream is)
                             throws IOException

Load a GIF format image using the BYTE_TYPE_INDEXED format (fastest)

Throws:

IOException

loadGIF

public static BufferedImage loadGIF(File f)
                             throws IOException

Load a GIF format image using the BYTE_TYPE_INDEXED format (fastest)

Throws:

IOException

saveGIF

public static void saveGIF(BufferedImage bi,
                           OutputStream os)
                    throws Exception

Saves an image as a GIF file to a stream.

Throws:

Exception

saveGIF

public static void saveGIF(BufferedImage bi,
                           File f)
                    throws Exception

Saves an image as a GIF file to a stream.

Throws:

Exception

savePNG

public static void savePNG(BufferedImage bi,
                           File f)
                    throws Exception

Throws:

Exception

savePNG

public static void savePNG(BufferedImage bi,
                           OutputStream f)
                    throws Exception

Throws:

Exception

loadFile

public static BufferedImage loadFile(File f)
                              throws IOException

Loads an image from a file. If the extension of the file is known (either gif, jpg or jpeg) then the file is loaded using one of the optimized loaders; if not the routine returns null.

Throws:

IOException

loadFile_image

public static Image loadFile_image(File f)
                            throws IOException

Loads an image from a file. If the extension of the file is known (either gif, jpg or jpeg) then the file is loaded using one of the optimized loaders; if not the routine returns null.

Throws:

IOException

loadStream

public static BufferedImage loadStream(InputStream is,
                                       String type)
                                throws IOException

Loads an image from a stream. The image type must contain jpg or jpeg for a JPEG file, or gif for a GIF file, or png for a PNG file.

Throws:

IOException

awtLoadImage

public static Image awtLoadImage(File f)
                          throws IOException

Loads the image from the file into an image. This loads exactly according to the AWT, without using any of the extensions. It will return a completely loaded image however.

Throws:

IOException

awtLoadBufferedImage

public static BufferedImage awtLoadBufferedImage(File f)
                                          throws IOException

Loads the image from the file into an image. This loads exactly according to the AWT, without using any of the extensions. After the load the image is copied into a BufferedImage and returned. This is VERY expensive so try to use another function instead!

Throws:

IOException

resizeFiltered_RAW

public static BufferedImage resizeFiltered_RAW(BufferedImage bi,
                                               int w,
                                               int h,
                                               ResamplerFilter fil)

resizeFiltered_RAW

public static BufferedImage resizeFiltered_RAW(BufferedImage i,
                                               int w,
                                               int h)

resizeFiltered

public static BufferedImage resizeFiltered(BufferedImage bi,
                                           int w,
                                           int h,
                                           ResamplerFilter fil)

Resizes a BufferedImage while keeping it's aspect ratio, using the optimal filtered stuff... This uses the default filter..

resizeFiltered

public static BufferedImage resizeFiltered(BufferedImage i,
                                           int w,
                                           int h)

Resizes a BufferedImage while keeping it's aspect ratio, using the optimal filtered stuff... This uses the default filter..

awtResize

public static BufferedImage awtResize(BufferedImage bi,
                                      int w,
                                      int h)

Resizes a BufferedImage while keeping it's aspect ratio, using the AWT mechanism... This returns a lower quality image; use resizeFiltered to get a filtered resampled image.

findQualityBySize

public static double findQualityBySize(BufferedImage bi,
                                       int sizenear)

Taking a BufferedImage, this function will try to find a JPEG quality factor that will save the image with a size around the size specified. This is done by looping a number of times and adjusting the quality until something reasonable is obtained.

saveImageByMime

public static void saveImageByMime(OutputStream os,
                                   BufferedImage bi,
                                   String mime)
                            throws Exception

Throws:

Exception

getImageDimension

public static Dimension getImageDimension(File resourceFile)
                                   throws IOException

Throws:

IOException

getImageDimension

@Nullable
public static Dimension getImageDimension(@Nonnull
                                                    InputStream is)
                                             throws IOException

Throws:

IOException

main

public static void main(String[] args)