File	Doc	Category	Size	Date	Package
ImageInputStreamSpi.java	API Doc	Java SE 5 API	6912	Fri Aug 26 14:57:30 BST 2005	javax.imageio.spi

ImageInputStreamSpi

• java.lang.Object
  • javax.imageio.spi.IIOServiceProvider

Fields Summary
protected Class	inputClass A Class object indicating the legal object type for use by the createInputStreamInstance method.

Constructors Summary
protected ImageInputStreamSpi() Constructs a blank ImageInputStreamSpi. It is up to the subclass to initialize instance variables and/or override method implementations in order to provide working versions of all methods.
public ImageInputStreamSpi(String vendorName, String version, Class inputClass) Constructs an ImageInputStreamSpi with a given set of values. param vendorName the vendor name. param version a version identifier. param inputClass a Class object indicating the legal object type for use by the createInputStreamInstance method. exception IllegalArgumentException if vendorName is null. exception IllegalArgumentException if version is null. super(vendorName, version); this.inputClass = inputClass;

Methods Summary
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. If false, the value of the useCache argument to createInputStreamInstance will be ignored. The default implementation returns false. return true if a cache file can be used by the input streams created by this service provider. return false;
public abstract javax.imageio.stream.ImageInputStream	createInputStreamInstance(java.lang.Object input, boolean useCache, java.io.File cacheDir) 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. param input an object of the class type returned by getInputClass. param useCache a boolean indicating whether a cache file should be used, in cases where it is optional. param cacheDir a File indicating where the cache file should be created, or null to use the system directory. return an ImageInputStream instance. exception IllegalArgumentException if input is not 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 a directory. exception IOException if a cache file is needed but cannot be created. see #getInputClass see #canUseCacheFile see #needsCacheFile
public javax.imageio.stream.ImageInputStream	createInputStreamInstance(java.lang.Object input) 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. param input an object of the class type returned by getInputClass. return an ImageInputStream instance. exception IllegalArgumentException if input is not an instance of the correct class or is null. exception IOException if a cache file is needed but cannot be created. see #getInputClass() return createInputStreamInstance(input, true, null);
public java.lang.Class	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. return a Class variable. see #createInputStreamInstance(Object, boolean, File) return inputClass;
public boolean	needsCacheFile() 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. return true if a cache file is needed by the input streams created by this service provider. return false;