OpenJDK 27 · javax.imageio.ImageIO · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
pack-priv static class	ImageIO.CacheInfo A class to hold information about caching.
pack-priv static class	ImageIO.CanDecodeInputFilter
pack-priv static class	ImageIO.CanEncodeImageAndFormatFilter
pack-priv static class	ImageIO.ContainsFilter
pack-priv static class	ImageIO.ImageReaderIterator
pack-priv static class	ImageIO.ImageTranscoderIterator
pack-priv static class	ImageIO.ImageWriterIterator
private static enum	ImageIO.SpiInfo
pack-priv static class	ImageIO.TranscoderFilter

Modifier and Type	Field and Description
private static final ImageIO.CacheInfo	info
private static Method	readerFileSuffixesMethod
private static Method	readerFormatNamesMethod
private static Method	readerMIMETypesMethod
private static final IIORegistry	theRegistry
private static Method	writerFileSuffixesMethod
private static Method	writerFormatNamesMethod
private static Method	writerMIMETypesMethod

Access	Constructor and Description
private	ImageIO() Constructor is private to prevent instantiation.

Method Summary

Modifier and Type	Method and Description
private static boolean	contains(String[] names, String name)
public static ImageInputStream	Returns: an `ImageInputStream`, or `null`. createImageInputStream(Object an `Object` to be used as an input source, such as a `File`, readable `RandomAccessFile`, or `InputStream`. input) Returns an `ImageInputStream` that will take its input from the given `Object`.
public static ImageOutputStream	Returns: an `ImageOutputStream`, or `null`. createImageOutputStream(Object an `Object` to be used as an output destination, such as a `File`, writable `RandomAccessFile`, or `OutputStream`. output) Returns an `ImageOutputStream` that will send its output to the given `Object`.
private static boolean	doWrite(RenderedImage im, ImageWriter writer, ImageOutputStream output) Writes image to output stream using given image writer.
public static File	Returns: a `File` indicating the directory where cache files will be created, or `null` to indicate the system-dependent default temporary-file directory. getCacheDirectory() Returns the current value set by `setCacheDirectory`, or `null` if no explicit setting has been made.
private static synchronized ImageIO.CacheInfo	getCacheInfo() Returns the `CacheInfo` object.
public static ImageReader	Returns: an `ImageReader`, or null. getImageReader(ImageWriter an instance of a registered `ImageWriter`. writer) Returns an `ImageReader` corresponding to the given `ImageWriter`, if there is one, or `null` if the plug-in for this `ImageWriter` does not specify a corresponding `ImageReader`, or if the given `ImageWriter` is not registered.
public static Iterator<ImageReader>	Returns: an `Iterator` containing `ImageReader`s. getImageReaders(Object an `ImageInputStream` or other `Object` containing encoded image data. input) Returns an `Iterator` containing all currently registered `ImageReader`s that claim to be able to decode the supplied `Object`, typically an `ImageInputStream`.
public static Iterator<ImageReader>	Returns: an `Iterator` containing `ImageReader`s. getImageReadersByFormatName(String a `String` containing the informal name of a format (e.g., "jpeg" or "tiff". formatName) Returns an `Iterator` containing all currently registered `ImageReader`s that claim to be able to decode the named format.
public static Iterator<ImageReader>	Returns: an `Iterator` containing `ImageReader`s. getImageReadersByMIMEType(String a `String` containing a file suffix (e.g., "image/jpeg" or "image/x-bmp"). MIMEType) Returns an `Iterator` containing all currently registered `ImageReader`s that claim to be able to decode files with the given MIME type.
public static Iterator<ImageReader>	Returns: an `Iterator` containing `ImageReader`s. getImageReadersBySuffix(String a `String` containing a file suffix (e.g., "jpg" or "tiff"). fileSuffix) Returns an `Iterator` containing all currently registered `ImageReader`s that claim to be able to decode files with the given suffix.
public static Iterator<ImageTranscoder>	Returns: an `Iterator` containing `ImageTranscoder`s. getImageTranscoders(ImageReader an `ImageReader`. reader, ImageWriter an `ImageWriter`. writer) Returns an `Iterator` containing all currently registered `ImageTranscoder`s that claim to be able to transcode between the metadata of the given `ImageReader` and `ImageWriter`.
public static ImageWriter	Returns: an `ImageWriter`, or null. getImageWriter(ImageReader an instance of a registered `ImageReader`. reader) Returns an `ImageWriter` corresponding to the given `ImageReader`, if there is one, or `null` if the plug-in for this `ImageReader` does not specify a corresponding `ImageWriter`, or if the given `ImageReader` is not registered.
public static Iterator<ImageWriter>	Returns: an `Iterator` containing `ImageWriter`s. getImageWriters(ImageTypeSpecifier an `ImageTypeSpecifier` indicating the layout of the image to be written. type, String the informal name of the `format`. formatName) Returns an `Iterator` containing all currently registered `ImageWriter`s that claim to be able to encode images of the given layout (specified using an `ImageTypeSpecifier`) in the given format.
public static Iterator<ImageWriter>	Returns: an `Iterator` containing `ImageWriter`s. getImageWritersByFormatName(String a `String` containing the informal name of a format (e.g., "jpeg" or "tiff". formatName) Returns an `Iterator` containing all currently registered `ImageWriter`s that claim to be able to encode the named format.
public static Iterator<ImageWriter>	Returns: an `Iterator` containing `ImageWriter`s. getImageWritersByMIMEType(String a `String` containing a file suffix (e.g., "image/jpeg" or "image/x-bmp"). MIMEType) Returns an `Iterator` containing all currently registered `ImageWriter`s that claim to be able to encode files with the given MIME type.
public static Iterator<ImageWriter>	Returns: an `Iterator` containing `ImageWriter`s. getImageWritersBySuffix(String a `String` containing a file suffix (e.g., "jpg" or "tiff"). fileSuffix) Returns an `Iterator` containing all currently registered `ImageWriter`s that claim to be able to encode files with the given suffix.
public static String[]	Returns: an array of `String`s. getReaderFileSuffixes() Returns an array of `String`s listing all of the file suffixes associated with the formats understood by the current set of registered readers.
public static String[]	Returns: an array of `String`s. getReaderFormatNames() Returns an array of `String`s listing all of the informal format names understood by the current set of registered readers.
public static String[]	Returns: an array of `String`s. getReaderMIMETypes() Returns an array of `String`s listing all of the MIME types understood by the current set of registered readers.
private static <S extends ImageReaderWriterSpi> String[]	getReaderWriterInfo(Class<S> spiClass, ImageIO.SpiInfo spiInfo)
private static String	getTempDir() Returns the default temporary (cache) directory as defined by the java.io.tmpdir system property.
public static boolean	Returns: true if a disk-based cache may be used for `ImageInputStream`s and `ImageOutputStream`s. getUseCache() Returns the current value set by `setUseCache`, or `true` if no explicit setting has been made.
private static ImageWriter	getWriter(RenderedImage im, String formatName) Returns `ImageWriter` instance according to given rendered image and image format or `null` if there is no appropriate writer.
public static String[]	Returns: an array of `String`s. getWriterFileSuffixes() Returns an array of `String`s listing all of the file suffixes associated with the formats understood by the current set of registered writers.
public static String[]	Returns: an array of `String`s. getWriterFormatNames() Returns an array of `String`s listing all of the informal format names understood by the current set of registered writers.
public static String[]	Returns: an array of `String`s. getWriterMIMETypes() Returns an array of `String`s listing all of the MIME types understood by the current set of registered writers.
private static boolean	hasCachePermission() Determines whether the caller has write access to the cache directory, stores the result in the `CacheInfo` object, and returns the decision.
public static BufferedImage	Returns: a `BufferedImage` containing the decoded contents of the input, or `null`. read(File a `File` to read from. input) Returns a `BufferedImage` as the result of decoding a supplied `File` with an `ImageReader` chosen automatically from among those currently registered.
public static BufferedImage	Returns: a `BufferedImage` containing the decoded contents of the input, or `null`. read(InputStream an `InputStream` to read from. input) Returns a `BufferedImage` as the result of decoding a supplied `InputStream` with an `ImageReader` chosen automatically from among those currently registered.
public static BufferedImage	Returns: a `BufferedImage` containing the decoded contents of the input, or `null`. read(URL a `URL` to read from. input) Returns a `BufferedImage` as the result of decoding a supplied `URL` with an `ImageReader` chosen automatically from among those currently registered.
public static BufferedImage	Returns: a `BufferedImage` containing the decoded contents of the input, or `null`. read(ImageInputStream an `ImageInputStream` to read from. stream) Returns a `BufferedImage` as the result of decoding a supplied `ImageInputStream` with an `ImageReader` chosen automatically from among those currently registered.
public static void	scanForPlugins() Scans for plug-ins on the application class path, loads their service provider classes, and registers a service provider instance for each one found with the `IIORegistry`.
public static void	setCacheDirectory(File a `File` specifying a directory. cacheDirectory) Sets the directory where cache files are to be created.
public static void	setUseCache(boolean a `boolean` indicating whether a cache file should be used, in cases where it is optional. useCache) Sets a flag indicating whether a disk-based cache file should be used when creating `ImageInputStream`s and `ImageOutputStream`s.
public static boolean	Returns: `false` if no appropriate writer is found. write(RenderedImage a `RenderedImage` to be written. im, String a `String` containing the informal name of the format. formatName, ImageOutputStream an `ImageOutputStream` to be written to. output) Writes an image using an arbitrary `ImageWriter` that supports the given format to an `ImageOutputStream`.
public static boolean	Returns: `false` if no appropriate writer is found. write(RenderedImage a `RenderedImage` to be written. im, String a `String` containing the informal name of the format. formatName, File a `File` to be written to. output) Writes an image using an arbitrary `ImageWriter` that supports the given format to a `File`.
public static boolean	Returns: `false` if no appropriate writer is found. write(RenderedImage a `RenderedImage` to be written. im, String a `String` containing the informal name of the format. formatName, OutputStream an `OutputStream` to be written to. output) Writes an image using an arbitrary `ImageWriter` that supports the given format to an `OutputStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public final Class ImageIO

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary