javax.imageio.stream
Class FileCacheImageOutputStream

java.lang.Object   
  javax.imageio.stream.ImageInputStreamImpl   
      javax.imageio.stream.ImageOutputStreamImpl   
          javax.imageio.stream.FileCacheImageOutputStream

All Implemented Interfaces:

DataInput , DataOutput , ImageInputStream , ImageOutputStream

public class FileCacheImageOutputStream
extends ImageOutputStreamImpl   

An implementation of ImageOutputStream that writes its output to a regular OutputStream. A file is used to cache data until it is flushed to the output stream.

Field Summary

Fields inherited from class javax.imageio.stream.ImageInputStreamImpl

bitOffset , byteOrder , flushedPos , streamPos

Constructor Summary

FileCacheImageOutputStream (OutputStream stream, File cacheDir)
Constructs a FileCacheImageOutputStream that will write to a given outputStream.

Method Summary

void	close () Closes this FileCacheImageOututStream.
void	flushBefore (long pos) Discards the initial portion of the stream prior to the indicated postion.
boolean	isCached () Returns true since this ImageOutputStream caches data in order to allow seeking backwards.
boolean	isCachedFile () Returns true since this ImageOutputStream maintains a file cache.
boolean	isCachedMemory () Returns false since this ImageOutputStream does not maintain a main memory cache.
long	length () Returns -1L to indicate that the stream has unknown length.
int	read () Reads a single byte from the stream and returns it as an integer between 0 and 255.
int	read (byte[] b, int off, int len) Reads up to len bytes from the stream, and stores them into b starting at index off.
void	seek (long pos) Sets the current stream position and resets the bit offset to 0.
void	write (byte[] b, int off, int len) Writes len bytes from array b, in order, to the output stream.
void	write (int b) Writes to the output stream the eight low-order bits of the argument b.

Methods inherited from class javax.imageio.stream.ImageOutputStreamImpl

flushBits , write , writeBit , writeBits , writeBoolean , writeByte , writeBytes , writeChar , writeChars , writeChars , writeDouble , writeDoubles , writeFloat , writeFloats , writeInt , writeInts , writeLong , writeLongs , writeShort , writeShorts , writeUTF

Methods inherited from class javax.imageio.stream.ImageInputStreamImpl

checkClosed , finalize , flush , getBitOffset , getByteOrder , getFlushedPosition , getStreamPosition , mark , 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 , setBitOffset , setByteOrder , skipBytes , skipBytes

Methods inherited from class java.lang.Object

clone , equals , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait

Methods inherited from interface javax.imageio.stream.ImageInputStream

flush , getBitOffset , getByteOrder , getFlushedPosition , getStreamPosition , mark , 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 , setBitOffset , setByteOrder , skipBytes , skipBytes

Constructor Detail

FileCacheImageOutputStream

public FileCacheImageOutputStream(OutputStream    stream,
                                  File    cacheDir)
                           throws IOException   

Constructs a FileCacheImageOutputStream that will write to a given outputStream.

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 OutputStream to write to.

cacheDir - a File indicating where the cache file should be created, or null to use the system directory.

Throws:

IllegalArgumentException - if stream is null.

IllegalArgumentException - if cacheDir is non-null but is not a directory.

IOException - if a cache file cannot be created.

Method Detail

read

public int read()
         throws IOException   

Description copied from interface: ImageInputStream

Reads a single byte from the stream and returns it as an integer between 0 and 255. If the end of the stream is reached, -1 is returned.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:

read in interface ImageInputStream

Specified by:

read in class ImageInputStreamImpl

Returns:

a byte value from the stream, as an int, or -1 to indicate EOF.

Throws:

IOException