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 MemoryCacheImageInputStream

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl extended by javax.imageio.stream.MemoryCacheImageInputStream
All Implemented Interfaces:
ImageInputStream

Most common way to construct:

ByteArrayInputStream inputByteStream = …;

MemoryCacheImageInputStream imageInStream = new MemoryCacheImageInputStream(inputByteStream);

Based on 8 examples


public class MemoryCacheImageInputStream
extends ImageInputStreamImpl

An implementation of ImageInputStream that gets its input from a regular InputStream. A memory buffer is used to cache at least the data between the discard position and the current read position.

In general, it is preferable to use a FileCacheImageInputStream when reading from a regular InputStream. This class is provided for cases where it is not possible to create a writable temporary file.


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

          Constructs a MemoryCacheImageInputStream that will read from a given InputStream.
 
Method Summary
 void

          Closes this MemoryCacheImageInputStream, freeing the cache.
protected void

          Finalizes this object prior to garbage collection.
 void
flushBefore(long pos)

          
 boolean

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

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

          Returns true since this ImageInputStream maintains a main memory cache.
 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.
 
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

MemoryCacheImageInputStream

public MemoryCacheImageInputStream(InputStream stream)
Constructs a MemoryCacheImageInputStream that will read from a given InputStream.

Parameters:
stream - an InputStream to read from.
Method Detail

close

public void close()
           throws IOException
Closes this MemoryCacheImageInputStream, freeing the cache. The source InputStream is not closed.

Overrides:
close in class ImageInputStreamImpl
Throws:
IOException

finalize

protected void finalize()
                 throws Throwable
{@inheritDoc}

Overrides:
finalize in class ImageInputStreamImpl
Throws:
Throwable

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 ImageInputStream caches data in order to allow seeking backwards.

Overrides:
isCached in class ImageInputStreamImpl
Returns:
true.

isCachedFile

public boolean isCachedFile()
Returns false since this ImageInputStream does not maintain a file cache.

Overrides:
isCachedFile in class ImageInputStreamImpl
Returns:
false.

isCachedMemory

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

Overrides:
isCachedMemory in class ImageInputStreamImpl
Returns:
true.

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


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