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 MemoryCacheImageOutputStream

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl extended by javax.imageio.stream.ImageOutputStreamImpl extended by javax.imageio.stream.MemoryCacheImageOutputStream
All Implemented Interfaces:
ImageInputStream, ImageOutputStream

Most common way to construct:

ByteArrayOutputStream baos = …;

MemoryCacheImageOutputStream mos = new MemoryCacheImageOutputStream(baos);

Based on 14 examples


public class MemoryCacheImageOutputStream
extends ImageOutputStreamImpl

An implementation of ImageOutputStream that writes its output to a regular OutputStream. A memory buffer is used to cache at least the data between the discard position and the current write position. The only constructor takes an OutputStream, so this class may not be used for read/modify/write operations. Reading can occur only on parts of the stream that have already been written to the cache and not yet flushed.


Field Summary
 
Fields inherited from class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos
 
Constructor Summary

          Constructs a MemoryCacheImageOutputStream that will write to a given OutputStream.
 
Method Summary
 void

          Closes this MemoryCacheImageOutputStream.
 void
flushBefore(long pos)

          
 boolean

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

          Returns false since this ImageOutputStream does not maintain a file cache.
 boolean

          Returns true since this ImageOutputStream maintains 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
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

MemoryCacheImageOutputStream

public MemoryCacheImageOutputStream(OutputStream stream)
Constructs a MemoryCacheImageOutputStream that will write to a given OutputStream.

Parameters:
stream - an OutputStream to write to.
Method Detail

close

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

Overrides:
close in class ImageInputStreamImpl
Throws:
IOException

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 false since this ImageOutputStream does not maintain a file cache.

Overrides:
isCachedFile in class ImageInputStreamImpl
Returns:
false.

isCachedMemory

public boolean isCachedMemory()
Returns true since this ImageOutputStream maintains a main memory cache.

Overrides:
isCachedMemory in class ImageInputStreamImpl
Returns:
true.

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

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