FileDocCategorySizeDatePackage
IIOServiceProvider.javaAPI DocJava SE 5 API5332Fri Aug 26 14:57:30 BST 2005javax.imageio.spi

IIOServiceProvider

public abstract class IIOServiceProvider extends Object implements RegisterableService
A superinterface for functionality common to all Image I/O service provider interfaces (SPIs). For more information on service provider classes, see the class comment for the IIORegistry class.
see
IIORegistry
see
javax.imageio.spi.ImageReaderSpi
see
javax.imageio.spi.ImageWriterSpi
see
javax.imageio.spi.ImageTranscoderSpi
see
javax.imageio.spi.ImageInputStreamSpi
version
0.5

Fields Summary
protected String
vendorName
A String to be returned from getVendorName, initially null. Constructors should set this to a non-null value.
protected String
version
A String to be returned from getVersion, initially null. Constructors should set this to a non-null value.
Constructors Summary
public IIOServiceProvider(String vendorName, String version)
Constructs an IIOServiceProvider with a given vendor name and version identifier.

param
vendorName the vendor name.
param
version a version identifier.
exception
IllegalArgumentException if vendorName is null.
exception
IllegalArgumentException if version is null.

        if (vendorName == null) {
            throw new IllegalArgumentException("vendorName == null!");
        }
        if (version == null) {
            throw new IllegalArgumentException("version == null!");
        }
        this.vendorName = vendorName;
        this.version = version;
    
public IIOServiceProvider()
Constructs a blank IIOServiceProvider. It is up to the subclass to initialize instance variables and/or override method implementations in order to ensure that the getVendorName and getVersion methods will return non-null values.

    
Methods Summary
public abstract java.lang.StringgetDescription(java.util.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.

param
locale a Locale for which the return value should be localized.
return
a String containing a description of this service provider.

public java.lang.StringgetVendorName()
Returns the name of the vendor responsible for creating this service provider and its associated implementation. Because the vendor name may be used to select a service provider, it is not localized.

The default implementation returns the value of the vendorName instance variable.

return
a non-null String containing the name of the vendor.

        return vendorName;
    
public java.lang.StringgetVersion()
Returns a string describing the version number of this service provider and its associated implementation. Because the version may be used by transcoders to identify the service providers they understand, this method is not localized.

The default implementation returns the value of the version instance variable.

return
a non-null String containing the version of this service provider.

        return version;
    
public voidonDeregistration(javax.imageio.spi.ServiceRegistry registry, java.lang.Class category)
A callback that will be whenever the Spi class has been deregistered from a ServiceRegistry.

Only the registry should call this method.

The default implementation does nothing.

see
ServiceRegistry#deregisterServiceProvider(Object provider)

public voidonRegistration(javax.imageio.spi.ServiceRegistry registry, java.lang.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.

see
ServiceRegistry#registerServiceProvider(Object provider)