com.communote.common.image

Class ImageHelper

java.lang.Object

com.communote.common.image.ImageHelper

public class ImageHelper
extends Object

Utility class for image transformations.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
static int	USER_IMAGE_MAX_SIZE The maximum of the image size is 5000 bytes

Method Summary

Modifier and Type	Method and Description
static BufferedImage	byteToImage(byte[] data) Converts the byte array to an image.
static byte[]	copyExifOrientation(byte[] sourceImage, byte[] result) This method will copy the Exif "orientation" information to the resulting image, if the original image contains this data too.
static boolean	createImageFile(byte[] data, String filename) Creates an image file and save it to the cache directory
static String	getMimeType(byte[] image) Method to get the best mime type for the given image.
static byte[]	imageFileToByteArray(File file, String format) Return the given image file as byte array
static byte[]	imageToByte(BufferedImage image, String format) Converts an image to a byte array in the given image format.
static byte[]	imageToByte(BufferedImage image, String format, Float compressionQuality) Converts an image to a byte array in the given image format
static BufferedImage	loadImage(File file) Loads an image from a file.

Methods inherited from class java.lang.Object

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

Field Detail

USER_IMAGE_MAX_SIZE

public static final int USER_IMAGE_MAX_SIZE

The maximum of the image size is 5000 bytes

See Also:

Constant Field Values

Method Detail

byteToImage

public static BufferedImage byteToImage(byte[] data)

Converts the byte array to an image.

Parameters:

data - Image as binary data.

Returns:

Returns a BufferedImage object or null.

copyExifOrientation

public static byte[] copyExifOrientation(byte[] sourceImage,
                                         byte[] result)

This method will copy the Exif "orientation" information to the resulting image, if the original image contains this data too.

Parameters:

sourceImage - The source image.

result - The original result.

Returns:

The new result containing the Exif orientation.

createImageFile

public static boolean createImageFile(byte[] data,
                                      String filename)

Creates an image file and save it to the cache directory

Parameters:

data - Image binary data

filename - Destination path of the given file

Returns:

If the creation of image file was successful, then returns true, else false

getMimeType

public static String getMimeType(byte[] image)

Method to get the best mime type for the given image.

Parameters:

image - The image to check.

Returns:

The mime type of the image or null if the bytes are not a valid image.

imageFileToByteArray

public static byte[] imageFileToByteArray(File file,
                                          String format)

Return the given image file as byte array

Parameters:

file - Image file

format - Image format

Returns:

Byte array

imageToByte

public static byte[] imageToByte(BufferedImage image,
                                 String format)

Converts an image to a byte array in the given image format. The image is not compressed.

Parameters:

image - BufferedImage object

format - Format for the transformation

Returns:

Returns the converted byte array

imageToByte

public static byte[] imageToByte(BufferedImage image,
                                 String format,
                                 Float compressionQuality)

Converts an image to a byte array in the given image format

Parameters:

image - BufferedImage object

format - Format for the transformation

compressionQuality - optional parameter to set a compression quality. The value is expected to be between 0 and 1 where 0 is interpreted as high compression and 1 as high quality. When passing null the image won't be compressed.

Returns:

Returns the converted byte array

loadImage

public static BufferedImage loadImage(File file)

Loads an image from a file.

Parameters:

file - File

Returns:

BufferedImage object