javax.imageio.spi

Class ImageOutputStreamSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageOutputStreamSpi

All Implemented Interfaces:

RegisterableService

public abstract class ImageOutputStreamSpi
extends IIOServiceProvider

An abstract superclass for service providers that create image output streams for a file, URL, byte array or any other target.

Since:

1.4

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<?>	outputClass Indicates which kind of output is produced by the streams created by createOutputStreamInstance(Object).

Fields inherited from class javax.imageio.spi.IIOServiceProvider

vendorName, version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageOutputStreamSpi() Constructs a service provider for image output streams, given no parameters.
	ImageOutputStreamSpi(java.lang.String vendorName, java.lang.String version, java.lang.Class<?> outputClass) Constructs a service provider for image output streams, given the vendor name, a version string and the kind of producable output.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canUseCacheFile() Determines whether ImageOutputStreams created by this service provider benefit from using a cache file.
javax.imageio.stream.ImageOutputStream	createOutputStreamInstance(java.lang.Object output)
abstract javax.imageio.stream.ImageOutputStream	createOutputStreamInstance(java.lang.Object output, boolean useCache, java.io.File cacheDir)
java.lang.Class<?>	getOutputClass() Determines which kind of output is produced by the streams created by createOutputStreamInstance(Object).
boolean	needsCacheFile() Determines whether ImageOutputStreams created by this service provider require the use of a cache file.

Methods inherited from class javax.imageio.spi.IIOServiceProvider

getDescription, getVendorName, getVersion, onDeregistration, onRegistration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outputClass

protected java.lang.Class<?> outputClass

Indicates which kind of output is produced by the streams created by createOutputStreamInstance(Object).

Constructor Detail

ImageOutputStreamSpi

protected ImageOutputStreamSpi()

Constructs a service provider for image output streams, given no parameters. It is up to the sub-class to set IIOServiceProvider.vendorName, IIOServiceProvider.version and outputClass to non-null values.

ImageOutputStreamSpi

public ImageOutputStreamSpi(java.lang.String vendorName,
                    java.lang.String version,
                    java.lang.Class<?> outputClass)

Constructs a service provider for image output streams, given the vendor name, a version string and the kind of producable output.

Throws:

java.lang.IllegalArgumentException - if vendorName or version is null.

Method Detail

getOutputClass

public java.lang.Class<?> getOutputClass()

Determines which kind of output is produced by the streams created by createOutputStreamInstance(Object).

canUseCacheFile

public boolean canUseCacheFile()

Determines whether ImageOutputStreams created by this service provider benefit from using a cache file.

The default behavior is to return false.

Returns:

true if the created streams are faster or need less memory when a cache file is being used; false if no positive effect results from the cache file.

needsCacheFile

public boolean needsCacheFile()

Determines whether ImageOutputStreams created by this service provider require the use of a cache file.

The default behavior is to return false.

Returns:

true if the created streams can only work when a cache file is being used; false if no cache file is needed.

createOutputStreamInstance

public abstract javax.imageio.stream.ImageOutputStream createOutputStreamInstance(java.lang.Object output,
                                                                boolean useCache,
                                                                java.io.File cacheDir)
                                                                           throws java.io.IOException

Throws:

java.io.IOException

createOutputStreamInstance

public javax.imageio.stream.ImageOutputStream createOutputStreamInstance(java.lang.Object output)
                                                                  throws java.io.IOException

Throws:

java.io.IOException