public final class Imaging extends Object
Almost all of the Apache Commons Imaging library's core functionality can be accessed through the methods provided by this class. The use of the Imaging class is similar to the Java API's ImageIO class, though Imaging supports formats and options not included in the standard Java API.
All of methods provided by the Imaging class are declared static.
The Apache Commons Imaging package is a pure Java implementation.
While the Apache Commons Imaging package handles a number of different graphics formats, support for some formats is not yet complete. For the most recent information on support for specific formats, refer to Format Support at the main project development web site.
Some of the methods provided by this class accept an optional params argument that permits the application to specify elements for special handling. If these specifications are not required by the application, the params argument may be omitted (as appropriate) or a null argument may be provided. In image-writing operations, the option parameters may include options such as data-compression type (if any), color model, or other format-specific data representations. The parameters map may also be used to provide EXIF Tags and other metadata to those formats that support them. In image-reading operations, the parameters may include information about special handling in reading the image data.
Optional parameters are specified using a Map object (typically, a Java HashMap) to specify a set of keys and values for input. The specification for support keys is provided by the ImagingConstants interface as well as by format-specific interfaces such as JpegContants or TiffConstants.
See the source of the SampleUsage class and other classes in the org.apache.commons.imaging.examples package for examples.
| Modifier and Type | Method and Description |
|---|---|
static String |
dumpImageFile(byte[] bytes)
Write the ImageInfo and format-specific information for the image
content of the specified byte array to a string.
|
static String |
dumpImageFile(File file)
Write the ImageInfo and format-specific information for the image
content of the specified file to a string.
|
static List<BufferedImage> |
getAllBufferedImages(byte[] bytes)
Gets all images specified by the byte array (some
formats may include multiple images within a single data source).
|
static List<BufferedImage> |
getAllBufferedImages(File file)
Gets all images specified by the file (some
formats may include multiple images within a single data source).
|
static List<BufferedImage> |
getAllBufferedImages(InputStream is,
String filename)
Gets all images specified by the InputStream (some
formats may include multiple images within a single data source).
|
static BufferedImage |
getBufferedImage(byte[] bytes)
Reads the first image from a byte array.
|
static BufferedImage |
getBufferedImage(byte[] bytes,
Map<String,Object> params)
Reads the first image from a byte array
using data-processing options specified through a parameters
map.
|
static BufferedImage |
getBufferedImage(File file)
Reads the first image from a file.
|
static BufferedImage |
getBufferedImage(File file,
Map<String,Object> params)
Reads the first image from a file
using data-processing options specified through a parameters
map.
|
static BufferedImage |
getBufferedImage(InputStream is)
Reads the first image from an InputStream.
|
static BufferedImage |
getBufferedImage(InputStream is,
Map<String,Object> params)
Reads the first image from an InputStream
using data-processing options specified through a parameters
map.
|
static FormatCompliance |
getFormatCompliance(byte[] bytes)
Attempts to determine the image format of the specified data and
evaluates its format compliance.
|
static FormatCompliance |
getFormatCompliance(File file)
Attempts to determine the image format of the specified data and
evaluates its format compliance.
|
static ICC_Profile |
getICCProfile(byte[] bytes)
Extracts an ICC Profile (if present) from JPEG, PNG, PSD (Photoshop) and
TIFF images.
|
static ICC_Profile |
getICCProfile(byte[] bytes,
Map<String,Object> params)
Extracts an ICC Profile (if present) from JPEG, PNG, PSD (Photoshop) and
TIFF images.
|
protected static ICC_Profile |
getICCProfile(ByteSource byteSource,
Map<String,Object> params) |
static ICC_Profile |
getICCProfile(File file)
Extracts an ICC Profile (if present) from JPEG, PNG, PSD (Photoshop) and
TIFF images.
|
static ICC_Profile |
getICCProfile(File file,
Map<String,Object> params)
Extracts an ICC Profile (if present) from JPEG, PNG, PSD (Photoshop) and
TIFF images.
|
static ICC_Profile |
getICCProfile(InputStream is,
String filename)
Extracts an ICC Profile (if present) from JPEG, PNG, PSD (Photoshop) and
TIFF images.
|
static ICC_Profile |
getICCProfile(InputStream is,
String filename,
Map<String,Object> params)
Extracts an ICC Profile (if present) from JPEG, PNG, PSD (Photoshop) and
TIFF images.
|
static byte[] |
getICCProfileBytes(byte[] bytes)
Extracts the raw bytes of an ICC Profile (if present) from JPEG, PNG, PSD
(Photoshop) and TIFF images.
|
static byte[] |
getICCProfileBytes(byte[] bytes,
Map<String,Object> params)
Extracts the raw bytes of an ICC Profile (if present) from JPEG, PNG, PSD
(Photoshop) and TIFF images.
|
static byte[] |
getICCProfileBytes(File file)
Extracts the raw bytes of an ICC Profile (if present) from JPEG, PNG, PSD
(Photoshop) and TIFF images.
|
static byte[] |
getICCProfileBytes(File file,
Map<String,Object> params)
Extracts the raw bytes of an ICC Profile (if present) from JPEG, PNG, PSD
(Photoshop) and TIFF images.
|
static ImageInfo |
getImageInfo(byte[] bytes)
Parses the "image info" of an image.
|
static ImageInfo |
getImageInfo(byte[] bytes,
Map<String,Object> params)
Parses the "image info" of an image.
|
static ImageInfo |
getImageInfo(File file)
Parses the "image info" of an image file.
|
static ImageInfo |
getImageInfo(File file,
Map<String,Object> params)
Parses the "image info" of an image file.
|
static ImageInfo |
getImageInfo(InputStream is,
String filename)
Parses the "image info" of an image.
|
static ImageInfo |
getImageInfo(InputStream is,
String filename,
Map<String,Object> params)
Parses the "image info" of an image.
|
static ImageInfo |
getImageInfo(String filename,
byte[] bytes)
Parses the "image info" of an image.
|
static ImageInfo |
getImageInfo(String filename,
byte[] bytes,
Map<String,Object> params)
Parses the "image info" of an image.
|
static Dimension |
getImageSize(byte[] bytes)
Determines the width and height of an image.
|
static Dimension |
getImageSize(byte[] bytes,
Map<String,Object> params)
Determines the width and height of an image.
|
static Dimension |
getImageSize(ByteSource byteSource,
Map<String,Object> params) |
static Dimension |
getImageSize(File file)
Determines the width and height of an image file.
|
static Dimension |
getImageSize(File file,
Map<String,Object> params)
Determines the width and height of an image file.
|
static Dimension |
getImageSize(InputStream is,
String filename)
Determines the width and height of an image.
|
static Dimension |
getImageSize(InputStream is,
String filename,
Map<String,Object> params)
Determines the width and height of an image.
|
static ImageMetadata |
getMetadata(byte[] bytes)
Parses the metadata of an image.
|
static ImageMetadata |
getMetadata(byte[] bytes,
Map<String,Object> params)
Parses the metadata of an image.
|
static ImageMetadata |
getMetadata(File file)
Parses the metadata of an image file.
|
static ImageMetadata |
getMetadata(File file,
Map<String,Object> params)
Parses the metadata of an image file.
|
static ImageMetadata |
getMetadata(InputStream is,
String filename)
Parses the metadata of an image file.
|
static ImageMetadata |
getMetadata(InputStream is,
String filename,
Map<String,Object> params)
Parses the metadata of an image file.
|
static String |
getXmpXml(byte[] bytes)
Extracts the embedded XML metadata as an XML string.
|
static String |
getXmpXml(byte[] bytes,
Map<String,Object> params)
Extracts the embedded XML metadata as an XML string.
|
static String |
getXmpXml(ByteSource byteSource,
Map<String,Object> params)
Extracts the embedded XML metadata as an XML string.
|
static String |
getXmpXml(File file)
Extracts the embedded XML metadata as an XML string.
|
static String |
getXmpXml(File file,
Map<String,Object> params)
Extracts the embedded XML metadata as an XML string.
|
static String |
getXmpXml(InputStream is,
String filename)
Extracts the embedded XML metadata as an XML string.
|
static String |
getXmpXml(InputStream is,
String filename,
Map<String,Object> params)
Extracts the embedded XML metadata as an XML string.
|
static ImageFormat |
guessFormat(byte[] bytes)
Attempts to determine the image format of a file based on its
"magic numbers," the first bytes of the data.
|
static ImageFormat |
guessFormat(ByteSource byteSource)
Attempts to determine the image format of a file based on its
"magic numbers," the first bytes of the data.
|
static ImageFormat |
guessFormat(File file)
Attempts to determine the image format of a file based on its
"magic numbers," the first bytes of the data.
|
static boolean |
hasImageFileExtension(File file)
Attempts to determine if a file contains an image recorded in
a supported graphics format based on its file-name extension
(for example ".jpg", ".gif", ".png", etc.).
|
static boolean |
hasImageFileExtension(String filename)
Attempts to determine if a file contains an image recorded in
a supported graphics format based on its file-name extension
(for example ".jpg", ".gif", ".png", etc.).
|
static void |
writeImage(BufferedImage src,
File file,
ImageFormat format,
Map<String,Object> params)
Writes the content of a BufferedImage to a file using the specified
image format.
|
static void |
writeImage(BufferedImage src,
OutputStream os,
ImageFormat format,
Map<String,Object> params)
Writes the content of a BufferedImage to an OutputStream using the specified
image format.
|
static byte[] |
writeImageToBytes(BufferedImage src,
ImageFormat format,
Map<String,Object> params)
Writes the content of a BufferedImage to a byte array using the specified
image format.
|
public static boolean hasImageFileExtension(File file)
file - A valid File object providing a reference to
a file that may contain an image.public static boolean hasImageFileExtension(String filename)
filename - A valid string representing name of file
which may contain an image.public static ImageFormat guessFormat(byte[] bytes) throws ImageReadException, IOException
Many graphics format specify identifying byte values that appear at the beginning of the data file. This method checks for such identifying elements and returns a ImageFormat enumeration indicating what it detects. Note that this method can return "false positives" in cases where non-image files begin with the specified byte values.
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionpublic static ImageFormat guessFormat(File file) throws ImageReadException, IOException
Many graphics formats specify identifying byte values that appear at the beginning of the data file. This method checks for such identifying elements and returns a ImageFormat enumeration indicating what it detects. Note that this method can return "false positives" in cases where non-image files begin with the specified byte values.
file - File containing image data.ImageReadExceptionIOExceptionpublic static ImageFormat guessFormat(ByteSource byteSource) throws ImageReadException, IOException
Many graphics formats specify identifying byte values that appear at the beginning of the data file. This method checks for such identifying elements and returns a ImageFormat enumeration indicating what it detects. Note that this method can return "false positives" in cases where non-image files begin with the specified byte values.
byteSource - a valid ByteSource object potentially supplying
data for an image.ImageReadException - in the event of an unsuccessful
attempt to read the image dataIOException - in the event of an unrecoverable I/O condition.public static ICC_Profile getICCProfile(byte[] bytes) throws ImageReadException, IOException
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionpublic static ICC_Profile getICCProfile(byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static ICC_Profile getICCProfile(InputStream is, String filename) throws ImageReadException, IOException
is - InputStream from which to read image data.filename - Filename associated with image data (optional).ImageReadExceptionIOExceptionpublic static ICC_Profile getICCProfile(InputStream is, String filename, Map<String,Object> params) throws ImageReadException, IOException
is - InputStream from which to read image data.filename - Filename associated with image data (optional).params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static ICC_Profile getICCProfile(File file) throws ImageReadException, IOException
file - File containing image data.ImageReadExceptionIOExceptionpublic static ICC_Profile getICCProfile(File file, Map<String,Object> params) throws ImageReadException, IOException
file - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionprotected static ICC_Profile getICCProfile(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageReadExceptionIOExceptionpublic static byte[] getICCProfileBytes(byte[] bytes)
throws ImageReadException,
IOException
To parse the result use IccProfileParser or ICC_Profile.getInstance(bytes).
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionIccProfileParser,
ICC_Profilepublic static byte[] getICCProfileBytes(byte[] bytes,
Map<String,Object> params)
throws ImageReadException,
IOException
To parse the result use IccProfileParser or ICC_Profile.getInstance(bytes).
bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionIccProfileParser,
ICC_Profilepublic static byte[] getICCProfileBytes(File file) throws ImageReadException, IOException
To parse the result use IccProfileParser or ICC_Profile.getInstance(bytes).
file - File containing image data.ImageReadExceptionIOExceptionIccProfileParser,
ICC_Profilepublic static byte[] getICCProfileBytes(File file, Map<String,Object> params) throws ImageReadException, IOException
To parse the result use IccProfileParser or ICC_Profile.getInstance(bytes).
file - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionIccProfileParser,
ICC_Profilepublic static ImageInfo getImageInfo(String filename, byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
filename - String.bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(String filename, byte[] bytes) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
filename - String.bytes - Byte array containing an image file.ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(InputStream is, String filename) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
is - InputStream from which to read image data.filename - Filename associated with image data (optional).ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(InputStream is, String filename, Map<String,Object> params) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
is - InputStream from which to read image data.filename - Filename associated with image data (optional).params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(byte[] bytes) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(File file, Map<String,Object> params) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
file - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageInfopublic static ImageInfo getImageInfo(File file) throws ImageReadException, IOException
"Image info" is a summary of basic information about the image such as: width, height, file format, bit depth, color type, etc.
Not to be confused with "image metadata."
file - File containing image data.ImageReadExceptionIOExceptionImageInfopublic static Dimension getImageSize(InputStream is, String filename) throws ImageReadException, IOException
is - InputStream from which to read image data.filename - Filename associated with image data (optional).ImageReadExceptionIOExceptionpublic static Dimension getImageSize(InputStream is, String filename, Map<String,Object> params) throws ImageReadException, IOException
is - InputStream from which to read image data.filename - Filename associated with image data (optional).params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static Dimension getImageSize(byte[] bytes) throws ImageReadException, IOException
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionpublic static Dimension getImageSize(byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static Dimension getImageSize(File file) throws ImageReadException, IOException
file - File containing image data.ImageReadExceptionIOExceptionpublic static Dimension getImageSize(File file, Map<String,Object> params) throws ImageReadException, IOException
file - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static Dimension getImageSize(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
ImageReadExceptionIOExceptionpublic static String getXmpXml(InputStream is, String filename) throws ImageReadException, IOException
is - InputStream from which to read image data.filename - Filename associated with image data (optional).ImageReadExceptionIOExceptionpublic static String getXmpXml(InputStream is, String filename, Map<String,Object> params) throws ImageReadException, IOException
is - InputStream from which to read image data.filename - Filename associated with image data (optional).params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static String getXmpXml(byte[] bytes) throws ImageReadException, IOException
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionpublic static String getXmpXml(byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static String getXmpXml(File file) throws ImageReadException, IOException
file - File containing image data.ImageReadExceptionIOExceptionpublic static String getXmpXml(File file, Map<String,Object> params) throws ImageReadException, IOException
file - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static String getXmpXml(ByteSource byteSource, Map<String,Object> params) throws ImageReadException, IOException
byteSource - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionpublic static ImageMetadata getMetadata(byte[] bytes) throws ImageReadException, IOException
JPEG/JFIF files may contain EXIF and/or IPTC metadata. PNG files may contain comments. TIFF files may contain metadata.
The instance of IImageMetadata returned by getMetadata() should be upcast (depending on image format).
Not to be confused with "image info."
bytes - Byte array containing an image file.ImageReadExceptionIOExceptionImageMetadatapublic static ImageMetadata getMetadata(byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
JPEG/JFIF files may contain EXIF and/or IPTC metadata. PNG files may contain comments. TIFF files may contain metadata.
The instance of IImageMetadata returned by getMetadata() should be upcast (depending on image format).
Not to be confused with "image info."
bytes - Byte array containing an image file.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageMetadatapublic static ImageMetadata getMetadata(InputStream is, String filename) throws ImageReadException, IOException
JPEG/JFIF files may contain EXIF and/or IPTC metadata. PNG files may contain comments. TIFF files may contain metadata.
The instance of IImageMetadata returned by getMetadata() should be upcast (depending on image format).
Not to be confused with "image info."
is - InputStream from which to read image data.filename - Filename associated with image data (optional).ImageReadExceptionIOExceptionImageMetadatapublic static ImageMetadata getMetadata(InputStream is, String filename, Map<String,Object> params) throws ImageReadException, IOException
JPEG/JFIF files may contain EXIF and/or IPTC metadata. PNG files may contain comments. TIFF files may contain metadata.
The instance of IImageMetadata returned by getMetadata() should be upcast (depending on image format).
Not to be confused with "image info."
is - InputStream from which to read image data.filename - Filename associated with image data (optional).params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageMetadatapublic static ImageMetadata getMetadata(File file) throws ImageReadException, IOException
JPEG/JFIF files may contain EXIF and/or IPTC metadata. PNG files may contain comments. TIFF files may contain metadata.
The instance of IImageMetadata returned by getMetadata() should be upcast (depending on image format).
Not to be confused with "image info."
file - File containing image data.ImageReadExceptionIOExceptionImageMetadatapublic static ImageMetadata getMetadata(File file, Map<String,Object> params) throws ImageReadException, IOException
JPEG/JFIF files may contain EXIF and/or IPTC metadata. PNG files may contain comments. TIFF files may contain metadata.
The instance of IImageMetadata returned by getMetadata() should be upcast (depending on image format).
Not to be confused with "image info."
file - File containing image data.params - Map of optional parameters, defined in ImagingConstants.ImageReadExceptionIOExceptionImageMetadatapublic static String dumpImageFile(byte[] bytes) throws ImageReadException, IOException
bytes - A valid array of bytes.ImageReadException - In the event that the the specified
content does not conform to the format of the specific parser
implementation.IOException - In the event of unsuccessful read or
access operation.public static String dumpImageFile(File file) throws ImageReadException, IOException
file - A valid file reference.ImageReadException - In the event that the the specified
content does not conform to the format of the specific parser
implementation.IOException - In the event of unsuccessful read or
access operation.public static FormatCompliance getFormatCompliance(byte[] bytes) throws ImageReadException, IOException
bytes - a valid array of bytes containing image data.ImageReadException - in the event of unreadable data.IOException - in the event of an unrecoverable I/O condition.public static FormatCompliance getFormatCompliance(File file) throws ImageReadException, IOException
file - valid file containing image dataImageReadException - in the event of unreadable data.IOException - in the event of an unrecoverable I/O condition.public static List<BufferedImage> getAllBufferedImages(InputStream is, String filename) throws ImageReadException, IOException
is - A valid InputStreamImageReadException - In the event that the the specified
content does not conform to the format of the specific parser
implementation.IOException - In the event of unsuccessful read or
access operation.public static List<BufferedImage> getAllBufferedImages(byte[] bytes) throws ImageReadException, IOException
bytes - a valid array of bytesImageReadException - In the event that the the specified
content does not conform to the format of the specific parser
implementation.IOException - In the event of unsuccessful read or
access operation.public static List<BufferedImage> getAllBufferedImages(File file) throws ImageReadException, IOException
file - A reference to a valid data file.ImageReadException - In the event that the the specified
content does not conform to the format of the specific parser
implementation.IOException - In the event of unsuccessful read or
access operation.public static BufferedImage getBufferedImage(InputStream is) throws ImageReadException, IOException
For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
is - a valid ImageStream from which to read data.ImageReadException - in the event of a processing error
while reading an image (i.e. a format violation, etc.).IOException - in the event of an unrecoverable I/O exception.public static BufferedImage getBufferedImage(InputStream is, Map<String,Object> params) throws ImageReadException, IOException
For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
is - a valid ImageStream from which to read data.params - an optional parameters map specifying optionsImageReadException - in the event of a processing error
while reading an image (i.e. a format violation, etc.).IOException - in the event of an unrecoverable I/O exception.public static BufferedImage getBufferedImage(byte[] bytes) throws ImageReadException, IOException
For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
bytes - a valid array of bytes from which to read data.ImageReadException - in the event of a processing error
while reading an image (i.e. a format violation, etc.).IOException - in the event of an unrecoverable I/O exception.public static BufferedImage getBufferedImage(byte[] bytes, Map<String,Object> params) throws ImageReadException, IOException
For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
bytes - a valid array of bytes from which to read data.params - an optional parameters map specifying options.ImageReadException - in the event of a processing error
while reading an image (i.e. a format violation, etc.).IOException - in the event of an unrecoverable I/O exception.public static BufferedImage getBufferedImage(File file) throws ImageReadException, IOException
For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
file - a valid reference to a file containing image data.ImageReadException - in the event of a processing error
while reading an image (i.e. a format violation, etc.).IOException - in the event of an unrecoverable I/O exception.public static BufferedImage getBufferedImage(File file, Map<String,Object> params) throws ImageReadException, IOException
For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
file - a valid reference to a file containing image data.ImageReadException - in the event of a processing error
while reading an image (i.e. a format violation, etc.).IOException - in the event of an unrecoverable I/O exception.public static void writeImage(BufferedImage src, File file, ImageFormat format, Map<String,Object> params) throws ImageWriteException, IOException
Image writing is not supported for all graphics formats. For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
src - a valid BufferedImage objectfile - the file to which the output image is to be writtenformat - the format in which the output image is to be writtenparams - an optional parameters map (nulls permitted)ImageWriteException - in the event of a format violation,
unsupported image format, etc.IOException - in the event of an unrecoverable I/O exception.ImagingConstantspublic static byte[] writeImageToBytes(BufferedImage src, ImageFormat format, Map<String,Object> params) throws ImageWriteException, IOException
Image writing is not supported for all graphics formats. For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
src - a valid BufferedImage objectformat - the format in which the output image is to be writtenparams - an optional parameters map (nulls permitted)ImageWriteException - in the event of a format violation,
unsupported image format, etc.IOException - in the event of an unrecoverable I/O exception.ImagingConstantspublic static void writeImage(BufferedImage src, OutputStream os, ImageFormat format, Map<String,Object> params) throws ImageWriteException, IOException
Image writing is not supported for all graphics formats. For the most recent information on support for specific formats, refer to Format Support at the main project development web site. While the Apache Commons Imaging package does not fully support all formats, it can read image info, metadata and ICC profiles from all image formats that provide this data.
src - a valid BufferedImage objectos - the OutputStream to which the output image is to be writtenformat - the format in which the output image is to be writtenparams - an optional parameters map (nulls permitted)ImageWriteException - in the event of a format violation,
unsupported image format, etc.IOException - in the event of an unrecoverable I/O exception.ImagingConstantsCopyright © 2007–2016 The Apache Software Foundation. All rights reserved.