ImageInputStreamSpi JDK 1.6)

Methods

public boolean canUseCacheFile ()

Returns true if the ImageInputStream implementation associated with this service provider can optionally make use of a cache file for improved performance and/or memory footrprint.

Returns true if the ImageInputStream implementation associated with this service provider can optionally make use of a cache file for improved performance and/or memory footrprint. If false, the value of the useCache argument to createInputStreamInstance will be ignored.

The default implementation returns false.
Returns: true if a cache file can be used by the input streams created by this service provider.

public ImageInputStream createInputStreamInstance (Object input) throws IOException

Returns an instance of the ImageInputStream implementation associated with this service provider.

Returns an instance of the ImageInputStream
implementation associated with this service provider. A cache
file will be created in the system-dependent default
temporary-file directory, if needed.
Returns: an ImageInputStream instance.
Parameters:
- input - an object of the class type returned by getInputClass.
Throws:
- IllegalArgumentException - if input is not an instance of the correct class or is null.
- IOException - if a cache file is needed but cannot be created.
See Also: ImageInputStreamSpi.getInputClass(),

publicabstract ImageInputStream createInputStreamInstance (Object input, boolean useCache, File cacheDir) throws IOException

Returns an instance of the ImageInputStream implementation associated with this service provider.

Returns an instance of the ImageInputStream
implementation associated with this service provider. If the
use of a cache file is optional, the useCache
parameter will be consulted. Where a cache is required, or
not applicable, the value of useCache will be ignored.
Returns: an ImageInputStream instance.
Parameters:
- input - an object of the class type returned by getInputClass.
- useCache - a boolean indicating whether a cache file should be used, in cases where it is optional.
- cacheDir - a File indicating where the cache file should be created, or null to use the system directory.
Throws:
- IllegalArgumentException - if input is not an instance of the correct class or is null.
- IllegalArgumentException - if a cache file is needed but cacheDir is non-null and is not a directory.
- IOException - if a cache file is needed but cannot be created.
See Also: ImageInputStreamSpi.getInputClass(), ImageInputStreamSpi.canUseCacheFile(), ImageInputStreamSpi.needsCacheFile(),

publicabstract String getDescription (Locale locale) [Inherited From IIOServiceProvider]

Returns a brief, human-readable description of this service provider and its associated implementation.

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.
Returns: a String containing a description of this service provider.
Parameters:
- locale - a Locale for which the return value should be localized.

public Class<Object> getInputClass ()

Returns a Class object representing the class or interface type that must be implemented by an input source in order to be "wrapped" in an ImageInputStream via the createInputStreamInstance method.

Typical return values might include InputStream.class or URL.class, but any class may be used.
Returns: a Class variable.
See Also: ImageInputStreamSpi.createInputStreamInstance(Object, boolean, File),

public String getVendorName () [Inherited From IIOServiceProvider]

Returns the name of the vendor responsible for creating this service provider and its associated implementation.

public String getVersion () [Inherited From IIOServiceProvider]

Returns a string describing the version number of this service provider and its associated implementation.

public boolean needsCacheFile ()

Returns true if the ImageInputStream implementation associated with this service provider requires the use of a cache File.

Returns true if the ImageInputStream implementation associated with this service provider requires the use of a cache File. If true, the value of the useCache argument to createInputStreamInstance will be ignored.

The default implementation returns false.
Returns: true if a cache file is needed by the input streams created by this service provider.

public void onDeregistration (ServiceRegistry registry, Class<Object> category) [Inherited From IIOServiceProvider]

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 Also: ServiceRegistry.deregisterServiceProvider(Object provider),

public void onRegistration (ServiceRegistry registry, Class<Object> category) [Inherited From IIOServiceProvider]

A callback that will be called exactly once after the Spi class has been instantiated and registered in a ServiceRegistry.

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 Also: ServiceRegistry.registerServiceProvider(Object provider),