Closeable, DataInput, AutoCloseable, ImageInputStream
public class MemoryCacheImageInputStream extends ImageInputStreamImpl
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.
bitOffset, byteOrder, flushedPos, streamPos
| Constructor | Description |
|---|---|
MemoryCacheImageInputStream |
Constructs a MemoryCacheImageInputStream that will read from a given InputStream. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
close() |
Closes this MemoryCacheImageInputStream, freeing the cache. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal. |
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 int between 0 and 255. |
int |
read |
Reads up to len bytes from the stream, and stores them into b starting at index off. |
checkClosed, flush, flushBefore, 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
public MemoryCacheImageInputStream(InputStream stream)
MemoryCacheImageInputStream that will read from a given InputStream.stream - an InputStream to read from.IllegalArgumentException - if stream is null.public int read() throws IOException
ImageInputStreamImplint between 0 and 255. If EOF is reached, -1 is returned. Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.
The bit offset within the stream must be reset to zero before the read occurs.
read in interface ImageInputStream
read in class ImageInputStreamImpl
-1 if EOF is reached.IOException - if the stream has been closed.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 ImageInputStream
read in class ImageInputStreamImpl
b - 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 boolean isCached()
true since this ImageInputStream caches data in order to allow seeking backwards.isCached in interface ImageInputStream
isCached in class ImageInputStreamImpl
true.public boolean isCachedFile()
false since this ImageInputStream does not maintain a file cache.isCachedFile in interface ImageInputStream
isCachedFile in class ImageInputStreamImpl
false.public boolean isCachedMemory()
true since this ImageInputStream maintains a main memory cache.isCachedMemory in interface ImageInputStream
isCachedMemory in class ImageInputStreamImpl
true.public void close() throws IOException
MemoryCacheImageInputStream, freeing the cache. The source InputStream is not closed.IOException - if an I/O error occurs.@Deprecated(since="9", forRemoval=true) protected void finalize() throws Throwable
Object.finalize() for background information and details about migration options.close method is called to close any open input source. This method should not be called from application code.finalize in class ImageInputStreamImpl
Throwable - if an error occurs during superclass finalization.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/imageio/stream/MemoryCacheImageInputStream.html