Summary: Inherited Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

BMPImageReaderSpi

extends ImageReaderSpi

java.lang.Object
↳	javax.imageio.spi.IIOServiceProvider
	↳	javax.imageio.spi.ImageReaderWriterSpi
		↳	javax.imageio.spi.ImageReaderSpi
			↳	com.sun.imageio.plugins.bmp.BMPImageReaderSpi

Summary

[Expand]

Inherited Fields

From class javax.imageio.spi.ImageReaderSpi

From class javax.imageio.spi.ImageReaderWriterSpi

protected String[]	MIMETypes	An array of strings to be returned from `getMIMETypes`, initially `null`.
protected String[]	extraImageMetadataFormatClassNames	An array of `String`s containing the class names of any additional image metadata formats supported by this plug-in, initially `null`.
protected String[]	extraImageMetadataFormatNames	An array of `String`s containing the names of any additional image metadata formats supported by this plug-in, initially `null`.
protected String[]	extraStreamMetadataFormatClassNames	An array of `String`s containing the class names of any additional stream metadata formats supported by this plug-in, initially `null`.
protected String[]	extraStreamMetadataFormatNames	An array of `String`s containing the names of any additional stream metadata formats supported by this plug-in, initially `null`.
protected String[]	names	An array of strings to be returned from `getFormatNames`, initially `null`.
protected String	nativeImageMetadataFormatClassName	A `String` containing the class name of the native stream metadata format supported by this plug-in, initially `null`.
protected String	nativeImageMetadataFormatName	A `String` containing the name of the native stream metadata format supported by this plug-in, initially `null`.
protected String	nativeStreamMetadataFormatClassName	A `String` containing the class name of the native stream metadata format supported by this plug-in, initially `null`.
protected String	nativeStreamMetadataFormatName	A `String` containing the name of the native stream metadata format supported by this plug-in, initially `null`.
protected String	pluginClassName	A `String` containing the name of the associated plug-in class, initially `null`.
protected String[]	suffixes	An array of strings to be returned from `getFileSuffixes`, initially `null`.
protected boolean	supportsStandardImageMetadataFormat	A boolean indicating whether this plug-in supports the standard metadata format for image metadata, initially `false`.
protected boolean	supportsStandardStreamMetadataFormat	A boolean indicating whether this plug-in supports the standard metadata format for stream metadata, initially `false`.

From class javax.imageio.spi.IIOServiceProvider

Public Constructors
	BMPImageReaderSpi()

Public Methods
boolean	canDecodeInput(Object source) Returns `true` if the supplied source object appears to be of the format supported by this reader.
ImageReader	createReaderInstance(Object extension) Returns an instance of the `ImageReader` implementation associated with this service provider.
String	getDescription(Locale locale) Returns a brief, human-readable description of this service provider and its associated implementation.
void	onRegistration(ServiceRegistry registry, Class<?> category) A callback that will be called exactly once after the Spi class has been instantiated and registered in a `ServiceRegistry`.

[Expand]

Inherited Methods

From class javax.imageio.spi.ImageReaderSpi

From class javax.imageio.spi.ImageReaderWriterSpi

String[]	getExtraImageMetadataFormatNames() Returns an array of `String`s containing the names of additional document formats, other than the native and standard formats, recognized by the `getAsTree` and `setFromTree` methods on the image metadata objects produced or consumed by this plug-in.
String[]	getExtraStreamMetadataFormatNames() Returns an array of `String`s containing the names of additional document formats, other than the native and standard formats, recognized by the `getAsTree` and `setFromTree` methods on the stream metadata objects produced or consumed by this plug-in.
String[]	getFileSuffixes() Returns an array of `String`s containing a list of file suffixes associated with the formats that are generally usable by the `ImageReader` or `ImageWriter` implementation associated with this service provider.
String[]	getFormatNames() Returns an array of `String`s containing human-readable names for the formats that are generally usable by the `ImageReader` or `ImageWriter` implementation associated with this service provider.
IIOMetadataFormat	getImageMetadataFormat(String formatName) Returns an `IIOMetadataFormat` object describing the given image metadata format, or `null` if no description is available.
String[]	getMIMETypes() Returns an array of `String`s containing a list of MIME types associated with the formats that are generally usable by the `ImageReader` or `ImageWriter` implementation associated with this service provider.
String	getNativeImageMetadataFormatName() Returns the name of the "native" image metadata format for this plug-in, which typically allows for lossless encoding and transmission of the image metadata stored in the format handled by this plug-in.
String	getNativeStreamMetadataFormatName() Returns the name of the "native" stream metadata format for this plug-in, which typically allows for lossless encoding and transmission of the stream metadata stored in the format handled by this plug-in.
String	getPluginClassName() Returns the fully-qualified class name of the `ImageReader` or `ImageWriter` plug-in associated with this service provider.
IIOMetadataFormat	getStreamMetadataFormat(String formatName) Returns an `IIOMetadataFormat` object describing the given stream metadata format, or `null` if no description is available.
boolean	isStandardImageMetadataFormatSupported() Returns `true` if the standard metadata format is among the document formats recognized by the `getAsTree` and `setFromTree` methods on the image metadata objects produced or consumed by this plug-in.
boolean	isStandardStreamMetadataFormatSupported() Returns `true` if the standard metadata format is among the document formats recognized by the `getAsTree` and `setFromTree` methods on the stream metadata objects produced or consumed by this plug-in.

From class javax.imageio.spi.IIOServiceProvider

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.imageio.spi.RegisterableService

Public Constructors

public BMPImageReaderSpi ()

Public Methods

public boolean canDecodeInput (Object source)

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	the object (typically an `ImageInputStream`) to be decoded.

Returns

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

Throws

IOException

public ImageReader createReaderInstance (Object extension)

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	a plug-in specific extension object, which may be `null`.

Returns

an ImageReader instance.

Throws

IIOException

public String getDescription (Locale locale)

Returns a brief, human-readable description of this service provider and its associated implementation. The resulting string should be localized for the supplied Locale, if possible.

Parameters

locale	a `Locale` for which the return value should be localized.

Returns

a String containing a description of this service provider.

public void onRegistration (ServiceRegistry registry, Class<?> category)

A callback that will be called exactly once after the Spi class has been instantiated and registered in a ServiceRegistry. This may be used to verify that the environment is suitable for this service, for example that native libraries can be loaded. If the service cannot function in the environment where it finds itself, it should deregister itself from the registry.

Only the registry should call this method.

The default implementation does nothing.

Parameters

registry	a `ServiceRegistry` where this object has been registered.
category	a `Class` object indicating the registry category under which this object has been registered.

Interfaces

Classes

BMPImageReaderSpi

Summary

Public Constructors

public BMPImageReaderSpi ()

Public Methods

public boolean canDecodeInput (Object source)

Parameters

Returns

Throws

public ImageReader createReaderInstance (Object extension)

Parameters

Returns

Throws

public String getDescription (Locale locale)

Parameters

Returns

public void onRegistration (ServiceRegistry registry, Class<?> category)

Parameters