Closeable
, DataInput
, AutoCloseable
, ImageInputStream
public class FileCacheImageInputStream extends ImageInputStreamImpl
ImageInputStream
that gets its input from a regular InputStream
. A file is used to cache previously read data.bitOffset, byteOrder, flushedPos, streamPos
Constructor | Description |
---|---|
FileCacheImageInputStream |
Constructs a FileCacheImageInputStream that will read from a given InputStream . |
Modifier and Type | Method | Description |
---|---|---|
void |
close() |
Closes this FileCacheImageInputStream , closing and removing the cache file. |
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 true since this ImageInputStream maintains a file cache. |
boolean |
isCachedMemory() |
Returns false since this ImageInputStream does not maintain 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 FileCacheImageInputStream(InputStream stream, File cacheDir) throws IOException
FileCacheImageInputStream
that will read from a given InputStream
. A temporary file is used as a cache. If cacheDir
is 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).
stream
- an InputStream
to read from.cacheDir
- a File
indicating where the cache file should be created, or null
to use the system directory.IllegalArgumentException
- if stream
is null
.IllegalArgumentException
- if cacheDir
is non-null
but is not a directory.IOException
- if a cache file cannot be created.public int read() throws IOException
ImageInputStreamImpl
int
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
ImageInputStreamImpl
len
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()
true
since this ImageInputStream
maintains a file cache.isCachedFile
in interface ImageInputStream
isCachedFile
in class ImageInputStreamImpl
true
.public boolean isCachedMemory()
false
since this ImageInputStream
does not maintain a main memory cache.isCachedMemory
in interface ImageInputStream
isCachedMemory
in class ImageInputStreamImpl
false
.public void close() throws IOException
FileCacheImageInputStream
, closing and removing the cache file. The source InputStream
is not closed.IOException
- if an 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/FileCacheImageInputStream.html