OpenJDK 27 · javax.imageio.spi.ImageReaderSpi · APIdia, the JavaDoc alternative

The service provider interface (SPI) for ImageReaders. For more information on service provider classes, see the class comment for the IIORegistry class.

Each ImageReaderSpi provides several types of information about the ImageReader class with which it is associated.

The name of the vendor who defined the SPI class and a brief description of the class are available via the getVendorName, getDescription, and getVersion methods. These methods may be internationalized to provide locale-specific output. These methods are intended mainly to provide short, human-readable information that might be used to organize a pop-up menu or other list.

Lists of format names, file suffixes, and MIME types associated with the service may be obtained by means of the getFormatNames, getFileSuffixes, and getMIMETypes methods. These methods may be used to identify candidate ImageReaders for decoding a particular file or stream based on manual format selection, file naming, or MIME associations (for example, when accessing a file over HTTP or as an email attachment).

A more reliable way to determine which ImageReaders are likely to be able to parse a particular data stream is provided by the canDecodeInput method. This methods allows the service provider to inspect the actual stream contents.

Finally, an instance of the ImageReader class associated with this service provider may be obtained by calling the createReaderInstance method. Any heavyweight initialization, such as the loading of native libraries or creation of large tables, should be deferred at least until the first invocation of this method.

Field Summary

Modifier and Type	Field and Description
protected Class<?>[]	inputTypes An array of `Class` objects to be returned from `getInputTypes`, initially `null`.
private Class<?>	readerClass The `Class` of the reader, initially `null`.
public static final Class<?>[]	STANDARD_INPUT_TYPE Deprecated Instead of using this field, directly create the equivalent array `{ ImageInputStream.class }`. A single-element array, initially containing `ImageInputStream.class`, to be returned from `getInputTypes`.
protected String[]	writerSpiNames An array of strings to be returned from `getImageWriterSpiNames`, initially `null`.

Inherited from javax.imageio.spi.ImageReaderWriterSpi:: extraImageMetadataFormatClassNames extraImageMetadataFormatNames extraStreamMetadataFormatClassNames extraStreamMetadataFormatNames MIMETypes names nativeImageMetadataFormatClassName nativeImageMetadataFormatName nativeStreamMetadataFormatClassName nativeStreamMetadataFormatName pluginClassName suffixes supportsStandardImageMetadataFormat supportsStandardStreamMetadataFormat

Constructor Summary

Access Constructor and Description

protected

Access	Constructor and Description
protected	ImageReaderSpi() Constructs a blank `ImageReaderSpi`.
public	ImageReaderSpi(String the vendor name, as a non-`null` `String`. vendorName, String a version identifier, as a non-`null` `String`. version, String[] a non-`null` array of `String`s indicating the format names. At least one entry must be present. names, String[] an array of `String`s indicating the common file suffixes. If no suffixes are defined, `null` should be supplied. An array of length 0 will be normalized to `null`. suffixes, String[] an array of `String`s indicating the format's MIME types. If no MIME types are defined, `null` should be supplied. An array of length 0 will be normalized to `null`. MIMETypes, String the fully-qualified name of the associated `ImageReader` class, as a non-`null String`. readerClassName, Class<?>[] a non-`null` array of `Class` objects of length at least 1 indicating the legal input types. inputTypes, String[] an array `String`s naming the classes of all associated `ImageWriter`s, or `null`. An array of length 0 is normalized to `null`. writerSpiNames, boolean a `boolean` that indicates whether a stream metadata object can use trees described by the standard metadata format. supportsStandardStreamMetadataFormat, String a `String`, or `null`, to be returned from `getNativeStreamMetadataFormatName`. nativeStreamMetadataFormatName, String a `String`, or `null`, to be used to instantiate a metadata format object to be returned from `getNativeStreamMetadataFormat`. nativeStreamMetadataFormatClassName, String[] an array of `String`s, or `null`, to be returned from `getExtraStreamMetadataFormatNames`. An array of length 0 is normalized to `null`. extraStreamMetadataFormatNames, String[] an array of `String`s, or `null`, to be used to instantiate a metadata format object to be returned from `getStreamMetadataFormat`. An array of length 0 is normalized to `null`. extraStreamMetadataFormatClassNames, boolean a `boolean` that indicates whether an image metadata object can use trees described by the standard metadata format. supportsStandardImageMetadataFormat, String a `String`, or `null`, to be returned from `getNativeImageMetadataFormatName`. nativeImageMetadataFormatName, String a `String`, or `null`, to be used to instantiate a metadata format object to be returned from `getNativeImageMetadataFormat`. nativeImageMetadataFormatClassName, String[] an array of `String`s to be returned from `getExtraImageMetadataFormatNames`. An array of length 0 is normalized to `null`. extraImageMetadataFormatNames, String[] an array of `String`s, or `null`, to be used to instantiate a metadata format object to be returned from `getImageMetadataFormat`. An array of length 0 is normalized to `null`. extraImageMetadataFormatClassNames) Constructs an `ImageReaderSpi` with a given set of values.

ImageReaderSpi()

Constructs a blank ImageReaderSpi.

public

ImageReaderSpi(String

the vendor name, as a non-null String.

vendorName, String

a version identifier, as a non-null String.

version, String[]

a non-null array of Strings indicating the format names. At least one entry must be present.

names, String[]

an array of Strings indicating the common file suffixes. If no suffixes are defined, null should be supplied. An array of length 0 will be normalized to null.

suffixes, String[]

an array of Strings indicating the format's MIME types. If no MIME types are defined, null should be supplied. An array of length 0 will be normalized to null.

MIMETypes, String

the fully-qualified name of the associated ImageReader class, as a non-null String.

readerClassName, Class<?>[]

a non-null array of Class objects of length at least 1 indicating the legal input types.

inputTypes, String[]

an array Strings naming the classes of all associated ImageWriters, or null. An array of length 0 is normalized to null.

writerSpiNames, boolean

a boolean that indicates whether a stream metadata object can use trees described by the standard metadata format.

supportsStandardStreamMetadataFormat, String

a String, or null, to be returned from getNativeStreamMetadataFormatName.

nativeStreamMetadataFormatName, String

a String, or null, to be used to instantiate a metadata format object to be returned from getNativeStreamMetadataFormat.

nativeStreamMetadataFormatClassName, String[]

an array of Strings, or null, to be returned from getExtraStreamMetadataFormatNames. An array of length 0 is normalized to null.

extraStreamMetadataFormatNames, String[]

an array of Strings, or null, to be used to instantiate a metadata format object to be returned from getStreamMetadataFormat. An array of length 0 is normalized to null.

extraStreamMetadataFormatClassNames, boolean

a boolean that indicates whether an image metadata object can use trees described by the standard metadata format.

supportsStandardImageMetadataFormat, String

a String, or null, to be returned from getNativeImageMetadataFormatName.

nativeImageMetadataFormatName, String

a String, or null, to be used to instantiate a metadata format object to be returned from getNativeImageMetadataFormat.

nativeImageMetadataFormatClassName, String[]

an array of Strings to be returned from getExtraImageMetadataFormatNames. An array of length 0 is normalized to null.

extraImageMetadataFormatNames, String[]

an array of Strings, or null, to be used to instantiate a metadata format object to be returned from getImageMetadataFormat. An array of length 0 is normalized to null.

extraImageMetadataFormatClassNames)

Constructs an ImageReaderSpi with a given set of values.

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: `true` if it is likely that this stream can be decoded. canDecodeInput(Object the object (typically an `ImageInputStream`) to be decoded. source) Returns `true` if the supplied source object appears to be of the format supported by this reader.
public ImageReader	Returns: an `ImageReader` instance. createReaderInstance() Returns an instance of the `ImageReader` implementation associated with this service provider.
public abstract ImageReader	Returns: an `ImageReader` instance. createReaderInstance(Object a plug-in specific extension object, which may be `null`. extension) Returns an instance of the `ImageReader` implementation associated with this service provider.
public String[]	Returns: an array of `String`s of length at least 1 containing names of `ImageWriterSpi`, or `null`. getImageWriterSpiNames() Returns an array of `String`s containing the fully qualified names of all the `ImageWriterSpi` classes that can understand the internal metadata representation used by the `ImageReader` associated with this service provider, or `null` if there are no such `ImageWriter`s specified.
public Class<?>[]	Returns: a non-`null` array of `Class` objects of length at least 1. getInputTypes() Returns an array of `Class` objects indicating what types of objects may be used as arguments to the reader's `setInput` method.
public boolean	Returns: `true` if `reader` is recognized. isOwnReader(ImageReader an `ImageReader` instance. reader) Returns `true` if the `ImageReader` object passed in is an instance of the `ImageReader` associated with this service provider.

Inherited from javax.imageio.spi.ImageReaderWriterSpi:: getExtraImageMetadataFormatNames getExtraStreamMetadataFormatNames getFileSuffixes getFormatNames getImageMetadataFormat getMIMETypes getNativeImageMetadataFormatName getNativeStreamMetadataFormatName getPluginClassName getStreamMetadataFormat isStandardImageMetadataFormatSupported isStandardStreamMetadataFormatSupported

Field Detail

inputTypes	back to summary
protected Class<?>[] inputTypes An array of `Class` objects to be returned from `getInputTypes`, initially `null`.

readerClass	back to summary
private Class<?> readerClass The `Class` of the reader, initially `null`.

STANDARD_INPUT_TYPE	back to summary
public static final Class<?>[] STANDARD_INPUT_TYPE Deprecated Instead of using this field, directly create the equivalent array `{ ImageInputStream.class }`. A single-element array, initially containing `ImageInputStream.class`, to be returned from `getInputTypes`. Annotations @Deprecated

writerSpiNames	back to summary
protected String[] writerSpiNames An array of strings to be returned from `getImageWriterSpiNames`, initially `null`.

Constructor Detail

ImageReaderSpi	back to summary
protected ImageReaderSpi() Constructs a blank `ImageReaderSpi`. It is up to the subclass to initialize instance variables and/or override method implementations in order to provide working versions of all methods.

ImageReaderSpi back to summary

ImageReaderSpi	back to summary
public ImageReaderSpi(String vendorName, String version, String[] names, String[] suffixes, String[] MIMETypes, String readerClassName, Class<?>[] inputTypes, String[] writerSpiNames, boolean supportsStandardStreamMetadataFormat, String nativeStreamMetadataFormatName, String nativeStreamMetadataFormatClassName, String[] extraStreamMetadataFormatNames, String[] extraStreamMetadataFormatClassNames, boolean supportsStandardImageMetadataFormat, String nativeImageMetadataFormatName, String nativeImageMetadataFormatClassName, String[] extraImageMetadataFormatNames, String[] extraImageMetadataFormatClassNames) Constructs an `ImageReaderSpi` with a given set of values. Parameters vendorName:String the vendor name, as a non-`null` `String`. version:String a version identifier, as a non-`null` `String`. names:String[] a non-`null` array of `String`s indicating the format names. At least one entry must be present. suffixes:String[] an array of `String`s indicating the common file suffixes. If no suffixes are defined, `null` should be supplied. An array of length 0 will be normalized to `null`. MIMETypes:String[] an array of `String`s indicating the format's MIME types. If no MIME types are defined, `null` should be supplied. An array of length 0 will be normalized to `null`. readerClassName:String the fully-qualified name of the associated `ImageReader` class, as a non-`null String`. inputTypes:Class<?>[] a non-`null` array of `Class` objects of length at least 1 indicating the legal input types. writerSpiNames:String[] an array `String`s naming the classes of all associated `ImageWriter`s, or `null`. An array of length 0 is normalized to `null`. supportsStandardStreamMetadataFormat:boolean a `boolean` that indicates whether a stream metadata object can use trees described by the standard metadata format. nativeStreamMetadataFormatName:String a `String`, or `null`, to be returned from `getNativeStreamMetadataFormatName`. nativeStreamMetadataFormatClassName:String a `String`, or `null`, to be used to instantiate a metadata format object to be returned from `getNativeStreamMetadataFormat`. extraStreamMetadataFormatNames:String[] an array of `String`s, or `null`, to be returned from `getExtraStreamMetadataFormatNames`. An array of length 0 is normalized to `null`. extraStreamMetadataFormatClassNames:String[] an array of `String`s, or `null`, to be used to instantiate a metadata format object to be returned from `getStreamMetadataFormat`. An array of length 0 is normalized to `null`. supportsStandardImageMetadataFormat:boolean a `boolean` that indicates whether an image metadata object can use trees described by the standard metadata format. nativeImageMetadataFormatName:String a `String`, or `null`, to be returned from `getNativeImageMetadataFormatName`. nativeImageMetadataFormatClassName:String a `String`, or `null`, to be used to instantiate a metadata format object to be returned from `getNativeImageMetadataFormat`. extraImageMetadataFormatNames:String[] an array of `String`s to be returned from `getExtraImageMetadataFormatNames`. An array of length 0 is normalized to `null`. extraImageMetadataFormatClassNames:String[] an array of `String`s, or `null`, to be used to instantiate a metadata format object to be returned from `getImageMetadataFormat`. An array of length 0 is normalized to `null`. Exceptions IllegalArgumentException: if `vendorName` is `null`. if `version` is `null`. if `names` is `null` or has length 0. if `readerClassName` is `null`. if `inputTypes` is `null` or has length 0.

public ImageReaderSpi(String vendorName, String version, String[] names, String[] suffixes, String[] MIMETypes, String readerClassName, Class<?>[] inputTypes, String[] writerSpiNames, boolean supportsStandardStreamMetadataFormat, String nativeStreamMetadataFormatName, String nativeStreamMetadataFormatClassName, String[] extraStreamMetadataFormatNames, String[] extraStreamMetadataFormatClassNames, boolean supportsStandardImageMetadataFormat, String nativeImageMetadataFormatName, String nativeImageMetadataFormatClassName, String[] extraImageMetadataFormatNames, String[] extraImageMetadataFormatClassNames)

Constructs an ImageReaderSpi with a given set of values.

Parameters

vendorName:String: the vendor name, as a non-null String.
version:String: a version identifier, as a non-null String.
names:String[]: a non-null array of Strings indicating the format names. At least one entry must be present.
suffixes:String[]: an array of Strings indicating the common file suffixes. If no suffixes are defined, null should be supplied. An array of length 0 will be normalized to null.
MIMETypes:String[]: an array of Strings indicating the format's MIME types. If no MIME types are defined, null should be supplied. An array of length 0 will be normalized to null.
readerClassName:String: the fully-qualified name of the associated ImageReader class, as a non-null String.
inputTypes:Class<?>[]: a non-null array of Class objects of length at least 1 indicating the legal input types.
writerSpiNames:String[]: an array Strings naming the classes of all associated ImageWriters, or null. An array of length 0 is normalized to null.
supportsStandardStreamMetadataFormat:boolean: a boolean that indicates whether a stream metadata object can use trees described by the standard metadata format.
nativeStreamMetadataFormatName:String: a String, or null, to be returned from getNativeStreamMetadataFormatName.
nativeStreamMetadataFormatClassName:String: a String, or null, to be used to instantiate a metadata format object to be returned from getNativeStreamMetadataFormat.
extraStreamMetadataFormatNames:String[]: an array of Strings, or null, to be returned from getExtraStreamMetadataFormatNames. An array of length 0 is normalized to null.
extraStreamMetadataFormatClassNames:String[]: an array of Strings, or null, to be used to instantiate a metadata format object to be returned from getStreamMetadataFormat. An array of length 0 is normalized to null.
supportsStandardImageMetadataFormat:boolean: a boolean that indicates whether an image metadata object can use trees described by the standard metadata format.
nativeImageMetadataFormatName:String: a String, or null, to be returned from getNativeImageMetadataFormatName.
nativeImageMetadataFormatClassName:String: a String, or null, to be used to instantiate a metadata format object to be returned from getNativeImageMetadataFormat.
extraImageMetadataFormatNames:String[]: an array of Strings to be returned from getExtraImageMetadataFormatNames. An array of length 0 is normalized to null.
extraImageMetadataFormatClassNames:String[]: an array of Strings, or null, to be used to instantiate a metadata format object to be returned from getImageMetadataFormat. An array of length 0 is normalized to null.

Exceptions

IllegalArgumentException:

if vendorName is null.
if version is null.
if names is null or has length 0.
if readerClassName is null.
if inputTypes is null or has length 0.

Method Detail

canDecodeInput back to summary

canDecodeInput	back to summary
public abstract boolean canDecodeInput(Object source) throws IOException Returns `true` if the supplied source object appears to be of the format supported by this reader. Returning `true` from this method does not guarantee that reading will succeed, only that there appears to be a reasonable chance of success based on a brief inspection of the stream contents. If the source is an `ImageInputStream`, implementations will commonly check the first several bytes of the stream for a "magic number" associated with the format. Once actual reading has commenced, the reader may still indicate failure at any time prior to the completion of decoding. It is important that the state of the object not be disturbed in order that other `ImageReaderSpi`s can properly determine whether they are able to decode the object. In particular, if the source is an `ImageInputStream`, a `mark`/`reset` pair should be used to preserve the stream position. Formats such as "raw," which can potentially attempt to read nearly any stream, should return `false` in order to avoid being invoked in preference to a closer match. If `source` is not an instance of one of the classes returned by `getInputTypes`, the method should simply return `false`. Parameters source:Object the object (typically an `ImageInputStream`) to be decoded. Returns:boolean `true` if it is likely that this stream can be decoded. Exceptions IOException: if an I/O error occurs while reading the stream. IllegalArgumentException: if `source` is `null`.

public abstract boolean canDecodeInput(Object source) throws IOException

Returns true if the supplied source object appears to be of the format supported by this reader. Returning true from this method does not guarantee that reading will succeed, only that there appears to be a reasonable chance of success based on a brief inspection of the stream contents. If the source is an ImageInputStream, implementations will commonly check the first several bytes of the stream for a "magic number" associated with the format. Once actual reading has commenced, the reader may still indicate failure at any time prior to the completion of decoding.

It is important that the state of the object not be disturbed in order that other ImageReaderSpis can properly determine whether they are able to decode the object. In particular, if the source is an ImageInputStream, a mark/reset pair should be used to preserve the stream position.

Formats such as "raw," which can potentially attempt to read nearly any stream, should return false in order to avoid being invoked in preference to a closer match.

If source is not an instance of one of the classes returned by getInputTypes, the method should simply return false.

Parameters

source:Object: the object (typically an ImageInputStream) to be decoded.

Returns:boolean

true if it is likely that this stream can be decoded.

Exceptions

IOException:: if an I/O error occurs while reading the stream.
IllegalArgumentException:: if source is null.

createReaderInstance back to summary

createReaderInstance	back to summary
public ImageReader createReaderInstance() throws IOException Returns an instance of the `ImageReader` implementation associated with this service provider. The returned object will initially be in an initial state as if its `reset` method had been called. The default implementation simply returns `createReaderInstance(null)`. Returns:ImageReader an `ImageReader` instance. Exceptions IOException: if an error occurs during loading, or initialization of the reader class, or during instantiation or initialization of the reader object.

public ImageReader createReaderInstance() throws IOException

Returns an instance of the ImageReader implementation associated with this service provider. The returned object will initially be in an initial state as if its reset method had been called.

The default implementation simply returns createReaderInstance(null).

Returns:ImageReader

an ImageReader instance.

Exceptions

IOException:: if an error occurs during loading, or initialization of the reader class, or during instantiation or initialization of the reader object.

createReaderInstance back to summary

createReaderInstance	back to summary
public abstract ImageReader createReaderInstance(Object extension) throws IOException Returns an instance of the `ImageReader` implementation associated with this service provider. The returned object will initially be in an initial state as if its `reset` method had been called. An `Object` may be supplied to the plug-in at construction time. The nature of the object is entirely plug-in specific. Typically, a plug-in will implement this method using code such as `return new MyImageReader(this)`. Parameters extension:Object a plug-in specific extension object, which may be `null`. Returns:ImageReader an `ImageReader` instance. Exceptions IOException: if the attempt to instantiate the reader fails. IllegalArgumentException: if the `ImageReader`'s constructor throws an `IllegalArgumentException` to indicate that the extension object is unsuitable.

public abstract ImageReader createReaderInstance(Object extension) throws IOException

Returns an instance of the ImageReader implementation associated with this service provider. The returned object will initially be in an initial state as if its reset method had been called.

An Object may be supplied to the plug-in at construction time. The nature of the object is entirely plug-in specific.

Typically, a plug-in will implement this method using code such as return new MyImageReader(this).

Parameters

extension:Object: a plug-in specific extension object, which may be null.

Returns:ImageReader

an ImageReader instance.

Exceptions

IOException:: if the attempt to instantiate the reader fails.
IllegalArgumentException:: if the ImageReader's constructor throws an IllegalArgumentException to indicate that the extension object is unsuitable.

getImageWriterSpiNames back to summary

getImageWriterSpiNames	back to summary
public String[] getImageWriterSpiNames() Returns an array of `String`s containing the fully qualified names of all the `ImageWriterSpi` classes that can understand the internal metadata representation used by the `ImageReader` associated with this service provider, or `null` if there are no such `ImageWriter`s specified. If a non-`null` value is returned, it must have non-zero length. The first item in the array must be the name of the service provider for the "preferred" writer, as it will be used to instantiate the `ImageWriter` returned by `ImageIO.getImageWriter(ImageReader)`. This mechanism may be used to obtain `ImageWriters` that will understand the internal structure of non-pixel meta-data (see `IIOTreeInfo`) generated by an `ImageReader`. By obtaining this data from the `ImageReader` and passing it on to one of the `ImageWriters` obtained with this method, a client program can read an image, modify it in some way, and write it back out while preserving all meta-data, without having to understand anything about the internal structure of the meta-data, or even about the image format. Returns:String[] an array of `String`s of length at least 1 containing names of `ImageWriterSpi`, or `null`. See Also `javax.imageio.ImageIO#getImageWriter(ImageReader)`

public String[] getImageWriterSpiNames()

Returns an array of Strings containing the fully qualified names of all the ImageWriterSpi classes that can understand the internal metadata representation used by the ImageReader associated with this service provider, or null if there are no such ImageWriters specified. If a non-null value is returned, it must have non-zero length.

The first item in the array must be the name of the service provider for the "preferred" writer, as it will be used to instantiate the ImageWriter returned by ImageIO.getImageWriter(ImageReader).

This mechanism may be used to obtain ImageWriters that will understand the internal structure of non-pixel meta-data (see IIOTreeInfo) generated by an ImageReader. By obtaining this data from the ImageReader and passing it on to one of the ImageWriters obtained with this method, a client program can read an image, modify it in some way, and write it back out while preserving all meta-data, without having to understand anything about the internal structure of the meta-data, or even about the image format.

Returns:String[]: an array of Strings of length at least 1 containing names of ImageWriterSpi, or null.
See Also: javax.imageio.ImageIO#getImageWriter(ImageReader)

getInputTypes back to summary

getInputTypes	back to summary
public Class<?>[] getInputTypes() Returns an array of `Class` objects indicating what types of objects may be used as arguments to the reader's `setInput` method. For most readers, which only accept input from an `ImageInputStream`, a single-element array containing `ImageInputStream.class` should be returned. Returns:Class<?>[] a non-`null` array of `Class` objects of length at least 1.

public Class<?>[] getInputTypes()

Returns an array of Class objects indicating what types of objects may be used as arguments to the reader's setInput method.

For most readers, which only accept input from an ImageInputStream, a single-element array containing ImageInputStream.class should be returned.

Returns:Class<?>[]: a non-null array of Class objects of length at least 1.

isOwnReader back to summary

isOwnReader	back to summary
public boolean isOwnReader(ImageReader reader) Returns `true` if the `ImageReader` object passed in is an instance of the `ImageReader` associated with this service provider. The default implementation compares the fully-qualified class name of the `reader` argument with the class name passed into the constructor. This method may be overridden if more sophisticated checking is required. Parameters reader:ImageReader an `ImageReader` instance. Returns:boolean `true` if `reader` is recognized. Exceptions IllegalArgumentException: if `reader` is `null`.

public boolean isOwnReader(ImageReader reader)

Returns true if the ImageReader object passed in is an instance of the ImageReader associated with this service provider.

The default implementation compares the fully-qualified class name of the reader argument with the class name passed into the constructor. This method may be overridden if more sophisticated checking is required.

Parameters

reader:ImageReader: an ImageReader instance.

Returns:boolean

true if reader is recognized.

Exceptions

IllegalArgumentException:: if reader is null.

public abstract Class ImageReaderSpi

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail