Class FileCacheImageInputStream
- java.lang.Object
-
- javax.imageio.stream.ImageInputStreamImpl
-
- javax.imageio.stream.FileCacheImageInputStream
- All Implemented Interfaces:
-
Closeable
,DataInput
,AutoCloseable
,ImageInputStream
public class FileCacheImageInputStream extends ImageInputStreamImpl
An implementation of ImageInputStream
that gets its input from a regular InputStream
. A file is used to cache previously read data.
Field Summary
Fields declared in class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos
Constructor Summary
Constructor | Description |
---|---|
FileCacheImageInputStream(InputStream stream,
File cacheDir) | Constructs a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void | close() | Closes this |
protected void | finalize() | Deprecated. The finalize method has been deprecated. |
boolean | isCached() | Returns |
boolean | isCachedFile() | Returns |
boolean | isCachedMemory() | Returns |
Methods declared in class javax.imageio.stream.ImageInputStreamImpl
checkClosed, length, mark, read, read, read, reset, skipBytes, skipBytes
Methods declared in class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods declared in interface javax.imageio.stream.ImageInputStream
flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, seek, setBitOffset, setByteOrder
Constructor Detail
FileCacheImageInputStream
public FileCacheImageInputStream(InputStream stream, File cacheDir) throws IOException
Constructs a 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).
- Parameters:
-
stream
- anInputStream
to read from. -
cacheDir
- aFile
indicating where the cache file should be created, ornull
to use the system directory. - Throws:
-
IllegalArgumentException
- ifstream
isnull
. -
IllegalArgumentException
- ifcacheDir
is non-null
but is not a directory. -
IOException
- if a cache file cannot be created.
Method Detail
isCached
public boolean isCached()
Returns true
since this ImageInputStream
caches data in order to allow seeking backwards.
- Specified by:
-
isCached
in interfaceImageInputStream
- Overrides:
-
isCached
in classImageInputStreamImpl
- Returns:
-
true
. - See Also:
-
isCachedMemory()
,isCachedFile()
isCachedFile
public boolean isCachedFile()
Returns true
since this ImageInputStream
maintains a file cache.
- Specified by:
-
isCachedFile
in interfaceImageInputStream
- Overrides:
-
isCachedFile
in classImageInputStreamImpl
- Returns:
-
true
. - See Also:
-
isCached()
,isCachedMemory()
isCachedMemory
public boolean isCachedMemory()
Returns false
since this ImageInputStream
does not maintain a main memory cache.
- Specified by:
-
isCachedMemory
in interfaceImageInputStream
- Overrides:
-
isCachedMemory
in classImageInputStreamImpl
- Returns:
-
false
. - See Also:
-
isCached()
,isCachedFile()
close
public void close() throws IOException
Closes this FileCacheImageInputStream
, closing and removing the cache file. The source InputStream
is not closed.
- Throws:
-
IOException
- if an error occurs.
finalize
@Deprecated(since="9") protected void finalize() throws Throwable
finalize
method has been deprecated. Subclasses that override finalize
in order to perform cleanup should be modified to use alternative cleanup mechanisms and to remove the overriding finalize
method. When overriding the finalize
method, its implementation must explicitly ensure that super.finalize()
is invoked as described in Object.finalize()
. See the specification for Object.finalize()
for further information about migration options.Finalizes this object prior to garbage collection. The close
method is called to close any open input source. This method should not be called from application code.
- Overrides:
-
finalize
in classImageInputStreamImpl
- Throws:
-
Throwable
- if an error occurs during superclass finalization. - See Also:
-
WeakReference
,PhantomReference