Class ImageUtils

java.lang.Object

io.github.palexdev.imcache.utils.ImageUtils

public class ImageUtils
extends Object

Utility class for handling various image-related operations.

Note: ImCache saves images on the disk with a custom format which contains the necessary data to reload them back with the same id as when it was requested.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	FILE_FORMAT_VERSION

Method Summary

Modifier and Type	Method	Description
static ImImage	deserialize(File file)	Deserializes the given file to an ImImage object only if the format version matches FILE_FORMAT_VERSION.
static void	serialize(ImImage img, File file)	Serializes the given ImImage object to the given file.
static byte[]	toBytes(String format, Object data)	Given an image as a generic type, converts it to a byte array.
static BufferedImage	toImage(Object data)	Given an image as a generic type, converts it to a BufferedImage object.
static InputStream	toStream(String format, Object data)	Given an image as a generic type, converts it to an InputStream object.

Methods inherited from class java.lang.Object

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

Field Details

FILE_FORMAT_VERSION

public static final byte FILE_FORMAT_VERSION

See Also:

• Constant Field Values

Method Details

serialize

public static void serialize(ImImage img,
 File file)
                      throws IOException

Serializes the given ImImage object to the given file.

Throws:

IOException

deserialize

public static ImImage deserialize(File file)
                           throws IOException

Deserializes the given file to an ImImage object only if the format version matches FILE_FORMAT_VERSION.

Throws:

IOException

toBytes

public static byte[] toBytes(String format,
 Object data)

Given an image as a generic type, converts it to a byte array.

Three types are currently supported:

1. A byte array returns data as is
2. A BufferedImage object is converted using ImageIO and the given format, see ImageIO.write(RenderedImage, String, OutputStream).
3. An InputStream object is converted to a byte array using InputStream.readAllBytes().

For other types or a null object, an empty array is returned.

toImage

public static BufferedImage toImage(Object data)

Given an image as a generic type, converts it to a BufferedImage object.

Three types are currently supported:

1. A BufferedImage object returns data as is.
2. A byte array is converted using ImageIO.read(InputStream).
3. An InputStream object is converted to a BufferedImage object using ImageIO.read(InputStream).

For other types or a null object, null is returned.

toStream

public static InputStream toStream(String format,
 Object data)

Given an image as a generic type, converts it to an InputStream object.

Three types are currently supported:

1. An InputStream object returns data as is.
2. A byte array is converted to an InputStream object using ByteArrayInputStream.
3. A BufferedImage object is converted to an InputStream object using ByteArrayInputStream and ImageIO.write(RenderedImage, String, OutputStream).

For other types or a null object, an empty InputStream is returned.