| |
|
| java.lang.Object
 javax.imageio.spi.IIOServiceProvider
javax.imageio.spi.ImageOutputStreamSpi
| ImageOutputStreamSpi | | abstract public class ImageOutputStreamSpi extends IIOServiceProvider (Code) | | The service provider interface (SPI) for
ImageOutputStreams. For more information on service
provider interfaces, see the class comment for the
IIORegistry class.
This interface allows arbitrary objects to be "wrapped" by
instances of ImageOutputStream. For example, a
particular ImageOutputStreamSpi might allow a generic
OutputStream to be used as a destination; another
might output to a File or to a device such as a serial
port.
By treating the creation of ImageOutputStreams as
a pluggable service, it becomes possible to handle future output
destinations without changing the API. Also, high-performance
implementations of ImageOutputStream (for example,
native implementations for a particular platform) can be installed
and used transparently by applications.
See Also: IIORegistry
See Also: javax.imageio.stream.ImageOutputStream
version:
0.5 |
| Field Summary | |
| protected Class | outputClass
A Class object indicating the legal object type
for use by the createInputStreamInstance method. |
| Constructor Summary | |
| protected | ImageOutputStreamSpi()
Constructs a blank ImageOutputStreamSpi. | | public | ImageOutputStreamSpi(String vendorName, String version, Class outputClass)
Constructs an ImageOutputStreamSpi with a given
set of values.
Parameters:
vendorName - the vendor name.
Parameters:
version - a version identifier.
Parameters:
outputClass - a Class object indicating thelegal object type for use by thecreateOutputStreamInstance method.
exception:
IllegalArgumentException - if vendorNameis null.
exception:
IllegalArgumentException - if versionis null. |
| Method Summary | |
| public boolean | canUseCacheFile()
Returns true if the ImageOutputStream
implementation associated with this service provider can
optionally make use of a cache File for improved
performance and/or memory footrprint. | | abstract public ImageOutputStream | createOutputStreamInstance(Object output, boolean useCache, File cacheDir)
Returns an instance of the ImageOutputStream
implementation associated with this service provider. | | public ImageOutputStream | createOutputStreamInstance(Object output)
Returns an instance of the ImageOutputStream
implementation associated with this service provider. | | public Class | getOutputClass()
Returns a Class object representing the class or
interface type that must be implemented by an output
destination in order to be "wrapped" in an
ImageOutputStream via the
createOutputStreamInstance method. | | public boolean | needsCacheFile()
Returns true if the ImageOutputStream
implementation associated with this service provider requires
the use of a cache File. |
| outputClass | | protected Class outputClass(Code) | | A Class object indicating the legal object type
for use by the createInputStreamInstance method.
|
| ImageOutputStreamSpi | | protected ImageOutputStreamSpi()(Code) | | Constructs a blank ImageOutputStreamSpi. It is up
to the subclass to initialize instance variables and/or
override method implementations in order to provide working
versions of all methods.
|
| ImageOutputStreamSpi | | public ImageOutputStreamSpi(String vendorName, String version, Class outputClass)(Code) | | Constructs an ImageOutputStreamSpi with a given
set of values.
Parameters:
vendorName - the vendor name.
Parameters:
version - a version identifier.
Parameters:
outputClass - a Class object indicating thelegal object type for use by thecreateOutputStreamInstance method.
exception:
IllegalArgumentException - if vendorNameis null.
exception:
IllegalArgumentException - if versionis null. |
| canUseCacheFile | | public boolean canUseCacheFile()(Code) | | Returns true if the ImageOutputStream
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 cacheFile argument to
createOutputStreamInstance will be ignored.
The default implementation returns false.
true if a cache file can be used by theoutput streams created by this service provider. |
| createOutputStreamInstance | | abstract public ImageOutputStream createOutputStreamInstance(Object output, boolean useCache, File cacheDir) throws IOException(Code) | | Returns an instance of the ImageOutputStream
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.
Parameters:
output - an object of the class type returned bygetOutputClass.
Parameters:
useCache - a boolean indicating whether acache file should be used, in cases where it is optional.
Parameters:
cacheDir - a File indicating where the cache file should be created, or null to use thesystem directory. an ImageOutputStream instance.
exception:
IllegalArgumentException - if output isnot an instance of the correct class or is null.
exception:
IllegalArgumentException - if a cache file is needed,but cacheDir is non-null and is not adirectory.
exception:
IOException - if a cache file is needed but cannot becreated.
See Also: ImageOutputStreamSpi.getOutputClass |
| createOutputStreamInstance | | public ImageOutputStream createOutputStreamInstance(Object output) throws IOException(Code) | | Returns an instance of the ImageOutputStream
implementation associated with this service provider. A cache
file will be created in the system-dependent default
temporary-file directory, if needed.
Parameters:
output - an object of the class type returned bygetOutputClass. an ImageOutputStream instance.
exception:
IllegalArgumentException - if output isnot an instance of the correct class or is null.
exception:
IOException - if a cache file is needed but cannot becreated.
See Also: ImageOutputStreamSpi.getOutputClass() |
| getOutputClass | | public Class getOutputClass()(Code) | | Returns a Class object representing the class or
interface type that must be implemented by an output
destination in order to be "wrapped" in an
ImageOutputStream via the
createOutputStreamInstance method.
Typical return values might include
OutputStream.class or File.class, but
any class may be used.
a Class variable.
See Also: ImageOutputStreamSpi.createOutputStreamInstance(Object,boolean,File) |
| needsCacheFile | | public boolean needsCacheFile()(Code) | | Returns true if the ImageOutputStream
implementation associated with this service provider requires
the use of a cache File.
The default implementation returns false.
true if a cache file is needed by theoutput streams created by this service provider. |
|
|
|