This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.imageio.stream
class FileCacheImageInputStream

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl extended by javax.imageio.stream.FileCacheImageInputStream
All Implemented Interfaces:
ImageInputStream
public class FileCacheImageInputStream
extends ImageInputStreamImpl

An implementation of ImageInputStream that gets its input from a regular InputStream. A file is used to cache previously read data.

Field Summary
 
Fields inherited from class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos
 
Constructor Summary
FileCacheImageInputStream(InputStream stream, File cacheDir)

          Constructs a FileCacheImageInputStream that will read from a given InputStream.
 
Method Summary
 void
close()

          Closes this FileCacheImageInputStream, closing and removing the cache file.
protected void
finalize()

          Finalizes this object prior to garbage collection.
 boolean
isCached()

          Returns true since this ImageInputStream caches data in order to allow seeking backwards.
 boolean
isCachedFile()

          Returns true since this ImageInputStream maintains a file cache.
 boolean
isCachedMemory()

          Returns false since this ImageInputStream does not maintain a main memory cache.
 int
read()

          Reads a single byte from the stream and returns it as an int between 0 and 255.
 int
read(byte[] b, int off, int len)

          Reads a single byte from the stream and returns it as an int between 0 and 255.
 
Methods inherited from class javax.imageio.stream.ImageInputStreamImpl
checkClosed, close, finalize, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileCacheImageInputStream

public FileCacheImageInputStream(InputStream stream,
                                 File cacheDir)
                          throws IOException
Constructs a FileCacheImageInputStream that will read from a given InputStream.

A temporary file is used as a cache. If cacheDiris non-null and is a directory, the file will be created there. If it is null, the system-dependent default temporary-file directory will be used (see the documentation for File.createTempFile for details).

Parameters:
stream - an InputStream to read from.
cacheDir - a File indicating where the cache file should be created, or null to use the system directory.
Throws:
IOException - if a cache file cannot be created.
Method Detail

close

public void close()
           throws IOException
Closes this FileCacheImageInputStream, closing and removing the cache file. The source InputStream is not closed.

Overrides:
close in class ImageInputStreamImpl
Throws:
IOException - if an error occurs.

finalize

protected void finalize()
                 throws Throwable
{@inheritDoc}

Overrides:
finalize in class ImageInputStreamImpl
Throws:
Throwable

isCached

public boolean isCached()
Returns true since this ImageInputStream caches data in order to allow seeking backwards.

Overrides:
isCached in class ImageInputStreamImpl
Returns:
true.

isCachedFile

public boolean isCachedFile()
Returns true since this ImageInputStream maintains a file cache.

Overrides:
isCachedFile in class ImageInputStreamImpl
Returns:
true.

isCachedMemory

public boolean isCachedMemory()
Returns false since this ImageInputStream does not maintain a main memory cache.

Overrides:
isCachedMemory in class ImageInputStreamImpl
Returns:
false.

read

public int read()
         throws IOException
Overrides:
read in class ImageInputStreamImpl
Throws:
IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
Overrides:
read in class ImageInputStreamImpl
Parameters:
b
off
len
Throws:
IOException
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.