javax.imageio.spi

Class ImageInputStreamSpi

java.lang.Object

javax.imageio.spi.IIOServiceProvider

javax.imageio.spi.ImageInputStreamSpi

All Implemented Interfaces:

RegisterableService

public abstract class ImageInputStreamSpi
extends IIOServiceProvider

服务提供者接口（SPI）为 ImageInputStreams。对服务提供者接口的更多信息，见的 IIORegistry类类的评论。

这个接口允许任意的对象是“包裹”的情况下，ImageInputStream。例如，一个特定的ImageInputStreamSpi可能允许一个通用的InputStream作为输入源；另一个可能从URL带输入。

通过对ImageInputStreams创作作为一个可插入的服务，它可以处理未来的输入源不改变API。同时，对ImageInputStream高性能实现的（例如，一个特定的平台实现原生）可以安装和透明地使用应用程序。

另请参见：

IIORegistry， ImageInputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected 类<?>	inputClass 一个 类指示使用的 createInputStreamInstance法法律的对象类型。

Fields inherited from class javax.imageio.spi.IIOServiceProvider

vendorName, version

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	ImageInputStreamSpi() 建立一个空白 ImageInputStreamSpi。
	ImageInputStreamSpi(String vendorName, String version, 类<?> inputClass) 构建一个给定的值的 ImageInputStreamSpi。

方法摘要

Modifier and Type	Method and Description
boolean	canUseCacheFile() 返回 true如果用这种服务提供商相关的 ImageInputStream实现可以利用缓存文件的改进和/或记忆footrprint。
ImageInputStream	createInputStreamInstance(Object input) 返回与该服务提供商相关的 ImageInputStream实现的一个实例。
abstract ImageInputStream	createInputStreamInstance(Object input, boolean useCache, File cacheDir) 返回与该服务提供商相关的 ImageInputStream实现的一个实例。
类<?>	getInputClass() 返回一个 类对象表示的类或接口类型必须为输入源代码实现的是“包装”通过 createInputStreamInstance方法在 ImageInputStream。
boolean	needsCacheFile() 返回 true如果用这种服务提供商相关的 ImageInputStream实施需要使用缓存 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

inputClass

protected 类<?> inputClass

一个 类指示使用的 createInputStreamInstance法法律的对象类型。

Constructor Detail

ImageInputStreamSpi

protected ImageInputStreamSpi()

建立一个空白 ImageInputStreamSpi。它是由子类初始化实例变量和/或重写方法实现，以提供所有方法的工作版本。

ImageInputStreamSpi

public ImageInputStreamSpi(String vendorName,
                           String version,
                           类<?> inputClass)

构建一个给定的值的 ImageInputStreamSpi。

参数

vendorName -供应商名称。

version -版本标识符。

inputClass - 类指示使用的 createInputStreamInstance法法律的对象类型。

异常

如果是 null vendorName IllegalArgumentException。

如果是 null version IllegalArgumentException。

方法详细信息

getInputClass

public 类<?> getInputClass()

返回一个 类对象表示的类或接口类型必须为输入源代码实现的是“包装”通过 createInputStreamInstance方法在 ImageInputStream。

典型的返回值可能包括InputStream.class或URL.class，但任何类都可以使用。

结果

一个 类变量。

另请参见：

createInputStreamInstance(Object, boolean, File)

canUseCacheFile

public boolean canUseCacheFile()

返回 true如果用这种服务提供商相关的 ImageInputStream实现可以利用缓存文件的改进和/或记忆footrprint。如果 false， useCache createInputStreamInstance的参数的值将被忽略。

默认的实现返回false。

结果

true如果缓存文件可以通过服务提供商创建输入流。

needsCacheFile

public boolean needsCacheFile()

返回 true如果用这种服务提供商相关的 ImageInputStream实施需要缓存 File使用。如果 true， useCache createInputStreamInstance的参数的值将被忽略。

默认的实现返回false。

结果

true如果缓存文件是通过服务提供者创建输入流的需要。

createInputStreamInstance

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

返回与该服务提供商相关的 ImageInputStream实现的一个实例。如果一个缓存文件的使用是可选的参数， useCache将咨询。在一个高速缓存是必需的，或不适用，对 useCache值将被忽略。

参数

input - getInputClass返回一个类类型的对象。

useCache - boolean指示缓存文件应该被使用，在情况下，它是可选的。

cacheDir - File标明缓存文件应该被创建，或 null使用系统目录。

结果

一个 ImageInputStream实例。

异常

IllegalArgumentException -如果 input不是正确的类的实例或是 null。

IllegalArgumentException -如果一个缓存文件是需要的但 cacheDir是非 null并不是一个目录。

IOException -如果一个缓存文件是需要的但不能被创造。

另请参见：

getInputClass()， canUseCacheFile()， needsCacheFile()

createInputStreamInstance

public ImageInputStream createInputStreamInstance(Object input)
                                           throws IOException

返回与该服务提供商相关的 ImageInputStream实现的一个实例。缓存文件将在系统依赖的默认临时文件目录中创建，如果需要的话。

参数

input -一个类类型的对象返回 getInputClass。

结果

一个 ImageInputStream实例。

异常

IllegalArgumentException -如果 input不是正确的类的实例或是 null。

IOException -如果一个缓存文件是需要的但不能被创造。

另请参见：

getInputClass()