|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectjavax.imageio.stream.ImageInputStreamImpl
javax.imageio.stream.MemoryCacheImageInputStream
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 | |
MemoryCacheImageInputStream(InputStream stream)
Constructs a MemoryCacheImageInputStream that will read
from a given InputStream. |
|
| Method Summary | |
void |
close()
Closes this MemoryCacheImageInputStream, freeing
the cache. |
void |
flushBefore(long pos)
Discards the initial portion of the stream prior to the indicated postion. |
boolean |
isCached()
Returns true since this
ImageInputStream caches data in order to allow
seeking backwards. |
boolean |
isCachedFile()
Returns false since this
ImageInputStream does not maintain a file cache. |
boolean |
isCachedMemory()
Returns true since this
ImageInputStream maintains a main memory cache. |
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. |
| Methods inherited from class javax.imageio.stream.ImageInputStreamImpl |
checkClosed, finalize, flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, length, 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, seek, setBitOffset, setByteOrder, skipBytes, skipBytes |
| Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public MemoryCacheImageInputStream(InputStream stream)
MemoryCacheImageInputStream that will read
from a given InputStream.
stream - an InputStream to read from.
IllegalArgumentException - if stream is
null.| Method Detail |
public int read()
throws IOException
ImageInputStreamThe bit offset within the stream is reset to zero before the read occurs.
read in interface ImageInputStreamread in class ImageInputStreamImplIOException
public int read(byte[] b,
int off,
int len)
throws IOException
ImageInputStreamImpllen bytes from the stream, and stores
them into b starting at index off.
If no bytes can be read because the end of the stream has been
reached, -1 is returned.
The bit offset within the stream must be reset to zero before the read occurs.
Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.
read in interface ImageInputStreamread in class ImageInputStreamImplb - an array of bytes to be written to.off - the starting position within b to write to.len - the maximum number of bytes to read.
-1
to indicate EOF.
IOException - if an I/O error occurs.
public void flushBefore(long pos)
throws IOException
ImageInputStreamIndexOutOfBoundsException.
Calling flushBefore may allow classes
implementing this interface to free up resources such as memory
or disk space that are being used to store data from the
stream.
flushBefore in interface ImageInputStreamflushBefore in class ImageInputStreamImplIOExceptionpublic boolean isCached()
true since this
ImageInputStream caches data in order to allow
seeking backwards.
isCached in interface ImageInputStreamisCached in class ImageInputStreamImpltrue.isCachedMemory(),
isCachedFile()public boolean isCachedFile()
false since this
ImageInputStream does not maintain a file cache.
isCachedFile in interface ImageInputStreamisCachedFile in class ImageInputStreamImplfalse.isCached(),
isCachedMemory()public boolean isCachedMemory()
true since this
ImageInputStream maintains a main memory cache.
isCachedMemory in interface ImageInputStreamisCachedMemory in class ImageInputStreamImpltrue.isCached(),
isCachedFile()
public void close()
throws IOException
MemoryCacheImageInputStream, freeing
the cache. The source InputStream is not closed.
close in interface ImageInputStreamclose in class ImageInputStreamImplIOException
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.