javax.imageio.spi
Class IIOServiceProvider

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.imageio.spi.IIOServiceProvider
All Implemented Interfaces:
RegisterableService sample code for javax.imageio.spi.RegisterableService definition code for javax.imageio.spi.RegisterableService
Direct Known Subclasses:
ImageInputStreamSpi sample code for javax.imageio.spi.ImageInputStreamSpi definition code for javax.imageio.spi.ImageInputStreamSpi , ImageOutputStreamSpi sample code for javax.imageio.spi.ImageOutputStreamSpi definition code for javax.imageio.spi.ImageOutputStreamSpi , ImageReaderWriterSpi sample code for javax.imageio.spi.ImageReaderWriterSpi definition code for javax.imageio.spi.ImageReaderWriterSpi , ImageTranscoderSpi sample code for javax.imageio.spi.ImageTranscoderSpi definition code for javax.imageio.spi.ImageTranscoderSpi

public abstract class IIOServiceProvider
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements RegisterableService sample code for javax.imageio.spi.RegisterableService definition code for javax.imageio.spi.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 Also:
IIORegistry sample code for javax.imageio.spi.IIORegistry definition code for javax.imageio.spi.IIORegistry , ImageReaderSpi sample code for javax.imageio.spi.ImageReaderSpi definition code for javax.imageio.spi.ImageReaderSpi , ImageWriterSpi sample code for javax.imageio.spi.ImageWriterSpi definition code for javax.imageio.spi.ImageWriterSpi , ImageTranscoderSpi sample code for javax.imageio.spi.ImageTranscoderSpi definition code for javax.imageio.spi.ImageTranscoderSpi , ImageInputStreamSpi sample code for javax.imageio.spi.ImageInputStreamSpi definition code for javax.imageio.spi.ImageInputStreamSpi

Field Summary
protected  String sample code for java.lang.String definition code for java.lang.String vendorName sample code for javax.imageio.spi.IIOServiceProvider.vendorName definition code for javax.imageio.spi.IIOServiceProvider.vendorName
          A String to be returned from getVendorName, initially null.
protected  String sample code for java.lang.String definition code for java.lang.String version sample code for javax.imageio.spi.IIOServiceProvider.version definition code for javax.imageio.spi.IIOServiceProvider.version
          A String to be returned from getVersion, initially null.
 
Constructor Summary
IIOServiceProvider sample code for javax.imageio.spi.IIOServiceProvider.IIOServiceProvider() definition code for javax.imageio.spi.IIOServiceProvider.IIOServiceProvider() ()
          Constructs a blank IIOServiceProvider.
IIOServiceProvider sample code for javax.imageio.spi.IIOServiceProvider.IIOServiceProvider(java.lang.String, java.lang.String) definition code for javax.imageio.spi.IIOServiceProvider.IIOServiceProvider(java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  vendorName, String sample code for java.lang.String definition code for java.lang.String  version)
          Constructs an IIOServiceProvider with a given vendor name and version identifier.
 
Method Summary
abstract  String sample code for java.lang.String definition code for java.lang.String getDescription sample code for javax.imageio.spi.IIOServiceProvider.getDescription(java.util.Locale) definition code for javax.imageio.spi.IIOServiceProvider.getDescription(java.util.Locale) (Locale sample code for java.util.Locale definition code for java.util.Locale  locale)
          Returns a brief, human-readable description of this service provider and its associated implementation.
 String sample code for java.lang.String definition code for java.lang.String getVendorName sample code for javax.imageio.spi.IIOServiceProvider.getVendorName() definition code for javax.imageio.spi.IIOServiceProvider.getVendorName() ()
          Returns the name of the vendor responsible for creating this service provider and its associated implementation.
 String sample code for java.lang.String definition code for java.lang.String getVersion sample code for javax.imageio.spi.IIOServiceProvider.getVersion() definition code for javax.imageio.spi.IIOServiceProvider.getVersion() ()
          Returns a string describing the version number of this service provider and its associated implementation.
 void onDeregistration sample code for javax.imageio.spi.IIOServiceProvider.onDeregistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) definition code for javax.imageio.spi.IIOServiceProvider.onDeregistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) (ServiceRegistry sample code for javax.imageio.spi.ServiceRegistry definition code for javax.imageio.spi.ServiceRegistry  registry, Class sample code for java.lang.Class definition code for java.lang.Class <?> category)
          A callback that will be whenever the Spi class has been deregistered from a ServiceRegistry.
 void onRegistration sample code for javax.imageio.spi.IIOServiceProvider.onRegistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) definition code for javax.imageio.spi.IIOServiceProvider.onRegistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) (ServiceRegistry sample code for javax.imageio.spi.ServiceRegistry definition code for javax.imageio.spi.ServiceRegistry  registry, Class sample code for java.lang.Class definition code for java.lang.Class <?> category)
          A callback that will be called exactly once after the Spi class has been instantiated and registered in a ServiceRegistry.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

vendorName sample code for javax.imageio.spi.IIOServiceProvider.vendorName

protected String sample code for java.lang.String definition code for java.lang.String  vendorName
A String to be returned from getVendorName, initially null. Constructors should set this to a non-null value.


version sample code for javax.imageio.spi.IIOServiceProvider.version

protected String sample code for java.lang.String definition code for java.lang.String  version
A String to be returned from getVersion, initially null. Constructors should set this to a non-null value.

Constructor Detail

IIOServiceProvider sample code for javax.imageio.spi.IIOServiceProvider(java.lang.String, java.lang.String) definition code for javax.imageio.spi.IIOServiceProvider(java.lang.String, java.lang.String)

public IIOServiceProvider(String sample code for java.lang.String definition code for java.lang.String  vendorName,
                          String sample code for java.lang.String definition code for java.lang.String  version)
Constructs an IIOServiceProvider with a given vendor name and version identifier.

Parameters:
vendorName - the vendor name.
version - a version identifier.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if vendorName is null.
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if version is null.

IIOServiceProvider sample code for javax.imageio.spi.IIOServiceProvider() definition code for javax.imageio.spi.IIOServiceProvider()

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.

Method Detail

onRegistration sample code for javax.imageio.spi.IIOServiceProvider.onRegistration(javax.imageio.spi.ServiceRegistry, java.lang.Class<?>) definition code for javax.imageio.spi.IIOServiceProvider.onRegistration(javax.imageio.spi.ServiceRegistry, java.lang.Class<?>)

public void onRegistration(ServiceRegistry sample code for javax.imageio.spi.ServiceRegistry definition code for javax.imageio.spi.ServiceRegistry  registry,
                           Class sample code for java.lang.Class definition code for 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.

Specified by:
onRegistration sample code for javax.imageio.spi.RegisterableService.onRegistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) definition code for javax.imageio.spi.RegisterableService.onRegistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) in interface RegisterableService sample code for javax.imageio.spi.RegisterableService definition code for javax.imageio.spi.RegisterableService
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.
See Also:
ServiceRegistry.registerServiceProvider(Object provider) sample code for javax.imageio.spi.ServiceRegistry.registerServiceProvider(java.lang.Object) definition code for javax.imageio.spi.ServiceRegistry.registerServiceProvider(java.lang.Object)

onDeregistration sample code for javax.imageio.spi.IIOServiceProvider.onDeregistration(javax.imageio.spi.ServiceRegistry, java.lang.Class<?>) definition code for javax.imageio.spi.IIOServiceProvider.onDeregistration(javax.imageio.spi.ServiceRegistry, java.lang.Class<?>)

public void onDeregistration(ServiceRegistry sample code for javax.imageio.spi.ServiceRegistry definition code for javax.imageio.spi.ServiceRegistry  registry,
                             Class sample code for java.lang.Class definition code for 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.

Specified by:
onDeregistration sample code for javax.imageio.spi.RegisterableService.onDeregistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) definition code for javax.imageio.spi.RegisterableService.onDeregistration(javax.imageio.spi.ServiceRegistry, java.lang.Class) in interface RegisterableService sample code for javax.imageio.spi.RegisterableService definition code for javax.imageio.spi.RegisterableService
Parameters:
registry - a ServiceRegistry from which this object is being (wholly or partially) deregistered.
category - a Class object indicating the registry category from which this object is being deregistered.
See Also:
ServiceRegistry.deregisterServiceProvider(Object provider) sample code for javax.imageio.spi.ServiceRegistry.deregisterServiceProvider(java.lang.Object) definition code for javax.imageio.spi.ServiceRegistry.deregisterServiceProvider(java.lang.Object)

getVendorName sample code for javax.imageio.spi.IIOServiceProvider.getVendorName() definition code for javax.imageio.spi.IIOServiceProvider.getVendorName()

public String sample code for java.lang.String definition code for java.lang.String  getVendorName()
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.

Returns:
a non-null String containing the name of the vendor.

getVersion sample code for javax.imageio.spi.IIOServiceProvider.getVersion() definition code for javax.imageio.spi.IIOServiceProvider.getVersion()

public String sample code for java.lang.String definition code for java.lang.String  getVersion()
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.

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

getDescription sample code for javax.imageio.spi.IIOServiceProvider.getDescription(java.util.Locale) definition code for javax.imageio.spi.IIOServiceProvider.getDescription(java.util.Locale)

public abstract String sample code for java.lang.String definition code for java.lang.String  getDescription(Locale sample code for java.util.Locale definition code for 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.

Parameters:
locale - a Locale for which the return value should be localized.
Returns:
a String containing a description of this service provider.