- java.lang.Object
-
- javax.imageio.spi.IIOServiceProvider
-
- javax.imageio.spi.ImageOutputStreamSpi
-
- All Implemented Interfaces:
- RegisterableService
public abstract class ImageOutputStreamSpi extends IIOServiceProvider
The service provider interface (SPI) forImageOutputStream
s. For more information on service provider interfaces, see the class comment for theIIORegistry
class.This interface allows arbitrary objects to be "wrapped" by instances of
ImageOutputStream
. For example, a particularImageOutputStreamSpi
might allow a genericOutputStream
to be used as a destination; another might output to aFile
or to a device such as a serial port.By treating the creation of
ImageOutputStream
s as a pluggable service, it becomes possible to handle future output destinations without changing the API. Also, high-performance implementations ofImageOutputStream
(for example, native implementations for a particular platform) can be installed and used transparently by applications.- See Also:
IIORegistry
,ImageOutputStream
-
-
Field Summary
Fields Modifier and Type Field and Description protected Class<?>
outputClass
AClass
object indicating the legal object type for use by thecreateInputStreamInstance
method.-
Fields inherited from class javax.imageio.spi.IIOServiceProvider
vendorName, version
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
ImageOutputStreamSpi()
Constructs a blankImageOutputStreamSpi
.ImageOutputStreamSpi(String vendorName, String version, Class<?> outputClass)
Constructs anImageOutputStreamSpi
with a given set of values.
-
Method Summary
Methods Modifier and Type Method and Description boolean
canUseCacheFile()
Returnstrue
if theImageOutputStream
implementation associated with this service provider can optionally make use of a cacheFile
for improved performance and/or memory footrprint.ImageOutputStream
createOutputStreamInstance(Object output)
Returns an instance of theImageOutputStream
implementation associated with this service provider.abstract ImageOutputStream
createOutputStreamInstance(Object output, boolean useCache, File cacheDir)
Returns an instance of theImageOutputStream
implementation associated with this service provider.Class<?>
getOutputClass()
Returns aClass
object representing the class or interface type that must be implemented by an output destination in order to be "wrapped" in anImageOutputStream
via thecreateOutputStreamInstance
method.boolean
needsCacheFile()
Returnstrue
if theImageOutputStream
implementation associated with this service provider requires the use of a cacheFile
.-
Methods inherited from class javax.imageio.spi.IIOServiceProvider
getDescription, getVendorName, getVersion, onDeregistration, onRegistration
-
-
-
-
Field Detail
-
outputClass
protected Class<?> outputClass
AClass
object indicating the legal object type for use by thecreateInputStreamInstance
method.
-
-
Constructor Detail
-
ImageOutputStreamSpi
protected ImageOutputStreamSpi()
Constructs a blankImageOutputStreamSpi
. 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)
Constructs anImageOutputStreamSpi
with a given set of values.- Parameters:
vendorName
- the vendor name.version
- a version identifier.outputClass
- aClass
object indicating the legal object type for use by thecreateOutputStreamInstance
method.- Throws:
IllegalArgumentException
- ifvendorName
isnull
.IllegalArgumentException
- ifversion
isnull
.
-
-
Method Detail
-
getOutputClass
public Class<?> getOutputClass()
Returns aClass
object representing the class or interface type that must be implemented by an output destination in order to be "wrapped" in anImageOutputStream
via thecreateOutputStreamInstance
method.Typical return values might include
OutputStream.class
orFile.class
, but any class may be used.- Returns:
- a
Class
variable. - See Also:
createOutputStreamInstance(Object, boolean, File)
-
canUseCacheFile
public boolean canUseCacheFile()
Returnstrue
if theImageOutputStream
implementation associated with this service provider can optionally make use of a cacheFile
for improved performance and/or memory footrprint. Iffalse
, the value of thecacheFile
argument tocreateOutputStreamInstance
will be ignored.The default implementation returns
false
.- Returns:
true
if a cache file can be used by the output streams created by this service provider.
-
needsCacheFile
public boolean needsCacheFile()
Returnstrue
if theImageOutputStream
implementation associated with this service provider requires the use of a cacheFile
.The default implementation returns
false
.- Returns:
true
if a cache file is needed by the output streams created by this service provider.
-
createOutputStreamInstance
public abstract ImageOutputStream createOutputStreamInstance(Object output, boolean useCache, File cacheDir) throws IOException
Returns an instance of theImageOutputStream
implementation associated with this service provider. If the use of a cache file is optional, theuseCache
parameter will be consulted. Where a cache is required, or not applicable, the value ofuseCache
will be ignored.- Parameters:
output
- an object of the class type returned bygetOutputClass
.useCache
- aboolean
indicating whether a cache file should be used, in cases where it is optional.cacheDir
- aFile
indicating where the cache file should be created, ornull
to use the system directory.- Returns:
- an
ImageOutputStream
instance. - Throws:
IllegalArgumentException
- ifoutput
is not an instance of the correct class or isnull
.IllegalArgumentException
- if a cache file is needed, butcacheDir
is non-null
and is not a directory.IOException
- if a cache file is needed but cannot be created.- See Also:
getOutputClass()
-
createOutputStreamInstance
public ImageOutputStream createOutputStreamInstance(Object output) throws IOException
Returns an instance of theImageOutputStream
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
.- Returns:
- an
ImageOutputStream
instance. - Throws:
IllegalArgumentException
- ifoutput
is not an instance of the correct class or isnull
.IOException
- if a cache file is needed but cannot be created.- See Also:
getOutputClass()
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
25/11/2024 02:15:14 Cette version de la page est en cache (à la date du 25/11/2024 02:15:14) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 31/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/imageio/spi/ImageOutputStreamSpi.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.