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.


javax.imageio.stream
class FileCacheImageOutputStream

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl extended by javax.imageio.stream.ImageOutputStreamImpl extended by javax.imageio.stream.FileCacheImageOutputStream
All Implemented Interfaces:
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

          Constructs a FileCacheImageOutputStream that will write to a given outputStream.
 
Method Summary
 void

          Closes this FileCacheImageOututStream.
 void
flushBefore(long pos)

          
 boolean

          Returns true since this ImageOutputStream caches data in order to allow seeking backwards.
 boolean

          Returns true since this ImageOutputStream maintains a file cache.
 boolean

          Returns false since this ImageOutputStream does not maintain a main memory cache.
 long

          Returns -1L to indicate that the stream has unknown length.
 int

          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.
 void
seek(long pos)

          Sets the current stream position and resets the bit offset to 0.
 void
write(byte[] b, int off, int len)

          
 void
write(int b)

          
 
Methods inherited from class javax.imageio.stream.ImageOutputStreamImpl
flushBits, write, write, 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, 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

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:
IOException - if a cache file cannot be created.
Method Detail

close

public void close()
           throws IOException
Closes this FileCacheImageOututStream. All pending data is flushed to the output, and the cache file is closed and removed. The destination OutputStream is not closed.

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

flushBefore

public void flushBefore(long pos)
                 throws IOException
Overrides:
flushBefore in class ImageInputStreamImpl
Parameters:
pos
Throws:
IOException

isCached

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

Overrides:
isCached in class ImageInputStreamImpl
Returns:
true.

isCachedFile

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

Overrides:
isCachedFile in class ImageInputStreamImpl
Returns:
true.

isCachedMemory

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

Overrides:
isCachedMemory in class ImageInputStreamImpl
Returns:
false.

length

public long length()
Overrides:
length in class ImageInputStreamImpl

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

seek

public void seek(long pos)
          throws IOException
Sets the current stream position and resets the bit offset to 0. It is legal to seek past the end of the file; an EOFException will be thrown only if a read is performed. The file length will not be increased until a write is performed.

Overrides:
seek in class ImageInputStreamImpl
Parameters:
pos
Throws:
IOException - if any other I/O error occurs.

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
Overrides:
write in class ImageOutputStreamImpl
Parameters:
b
off
len
Throws:
IOException

write

public void write(int b)
           throws IOException
Overrides:
write in class ImageOutputStreamImpl
Parameters:
b
Throws:
IOException


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/.