public class

WBMPImageWriterSpi

extends ImageWriterSpi
java.lang.Object
   ↳ javax.imageio.spi.IIOServiceProvider
     ↳ javax.imageio.spi.ImageReaderWriterSpi
       ↳ javax.imageio.spi.ImageWriterSpi
         ↳ com.sun.imageio.plugins.wbmp.WBMPImageWriterSpi

Summary

[Expand]
Inherited Fields
From class javax.imageio.spi.ImageWriterSpi
From class javax.imageio.spi.ImageReaderWriterSpi
From class javax.imageio.spi.IIOServiceProvider
Public Constructors
WBMPImageWriterSpi()
Public Methods
boolean canEncodeImage(ImageTypeSpecifier type)
Returns true if the ImageWriter implementation associated with this service provider is able to encode an image with the given layout.
ImageWriter createWriterInstance(Object extension)
Returns an instance of the ImageWriter 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.ImageWriterSpi
From class javax.imageio.spi.ImageReaderWriterSpi
From class javax.imageio.spi.IIOServiceProvider
From class java.lang.Object
From interface javax.imageio.spi.RegisterableService

Public Constructors

public WBMPImageWriterSpi ()

Public Methods

public boolean canEncodeImage (ImageTypeSpecifier type)

Returns true if the ImageWriter implementation associated with this service provider is able to encode an image with the given layout. The layout (i.e., the image's SampleModel and ColorModel) is described by an ImageTypeSpecifier object.

A return value of true is not an absolute guarantee of successful encoding; the encoding process may still produce errors due to factors such as I/O errors, inconsistent or malformed data structures, etc. The intent is that a reasonable inspection of the basic structure of the image be performed in order to determine if it is within the scope of the encoding format. For example, a service provider for a format that can only encode greyscale would return false if handed an RGB BufferedImage. Similarly, a service provider for a format that can encode 8-bit RGB imagery might refuse to encode an image with an associated alpha channel.

Different ImageWriters, and thus service providers, may choose to be more or less strict. For example, they might accept an image with premultiplied alpha even though it will have to be divided out of each pixel, at some loss of precision, in order to be stored.

Parameters
type an ImageTypeSpecifier specifying the layout of the image to be written.
Returns
  • true if this writer is likely to be able to encode images with the given layout.

public ImageWriter createWriterInstance (Object extension)

Returns an instance of the ImageWriter 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 MyImageWriter(this).

Parameters
extension a plug-in specific extension object, which may be null.
Returns
  • an ImageWriter 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.