FileImageInputStream (Java SE 15 & JDK 15) (original) (raw)
All Implemented Interfaces:
[Closeable](../../../../java.base/java/io/Closeable.html "interface in java.io")
, [DataInput](../../../../java.base/java/io/DataInput.html "interface in java.io")
, [AutoCloseable](../../../../java.base/java/lang/AutoCloseable.html "interface in java.lang")
, [ImageInputStream](ImageInputStream.html "interface in javax.imageio.stream")
public class FileImageInputStream extends ImageInputStreamImpl
An implementation of ImageInputStream
that gets its input from a File
or RandomAccessFile
. The file contents are assumed to be stable during the lifetime of the object.
Field Summary
Constructor Summary
Constructors
Constructor | Description |
---|---|
FileImageInputStream(File f) | Constructs a FileImageInputStream that will read from a given File. |
FileImageInputStream(RandomAccessFile raf) | Constructs a FileImageInputStream that will read from a given RandomAccessFile. |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
protected void | finalize() | Deprecated. |
long | length() | Returns the length of the underlying file, or -1 if it is unknown. |
Methods declared in class javax.imageio.stream.ImageInputStreamImpl
[checkClosed](ImageInputStreamImpl.html#checkClosed%28%29), [isCached](ImageInputStreamImpl.html#isCached%28%29), [isCachedFile](ImageInputStreamImpl.html#isCachedFile%28%29), [isCachedMemory](ImageInputStreamImpl.html#isCachedMemory%28%29), [mark](ImageInputStreamImpl.html#mark%28%29), [read](ImageInputStreamImpl.html#read%28%29), [read](ImageInputStreamImpl.html#read%28byte%5B%5D%29), [read](ImageInputStreamImpl.html#read%28byte%5B%5D,int,int%29), [reset](ImageInputStreamImpl.html#reset%28%29), [skipBytes](ImageInputStreamImpl.html#skipBytes%28int%29), [skipBytes](ImageInputStreamImpl.html#skipBytes%28long%29)
Methods declared in interface javax.imageio.stream.ImageInputStream
[close](ImageInputStream.html#close%28%29), [flush](ImageInputStream.html#flush%28%29), [flushBefore](ImageInputStream.html#flushBefore%28long%29), [getBitOffset](ImageInputStream.html#getBitOffset%28%29), [getByteOrder](ImageInputStream.html#getByteOrder%28%29), [getFlushedPosition](ImageInputStream.html#getFlushedPosition%28%29), [getStreamPosition](ImageInputStream.html#getStreamPosition%28%29), [readBit](ImageInputStream.html#readBit%28%29), [readBits](ImageInputStream.html#readBits%28int%29), [readBoolean](ImageInputStream.html#readBoolean%28%29), [readByte](ImageInputStream.html#readByte%28%29), [readBytes](ImageInputStream.html#readBytes%28javax.imageio.stream.IIOByteBuffer,int%29), [readChar](ImageInputStream.html#readChar%28%29), [readDouble](ImageInputStream.html#readDouble%28%29), [readFloat](ImageInputStream.html#readFloat%28%29), [readFully](ImageInputStream.html#readFully%28byte%5B%5D%29), [readFully](ImageInputStream.html#readFully%28byte%5B%5D,int,int%29), [readFully](ImageInputStream.html#readFully%28char%5B%5D,int,int%29), [readFully](ImageInputStream.html#readFully%28double%5B%5D,int,int%29), [readFully](ImageInputStream.html#readFully%28float%5B%5D,int,int%29), [readFully](ImageInputStream.html#readFully%28int%5B%5D,int,int%29), [readFully](ImageInputStream.html#readFully%28long%5B%5D,int,int%29), [readFully](ImageInputStream.html#readFully%28short%5B%5D,int,int%29), [readInt](ImageInputStream.html#readInt%28%29), [readLine](ImageInputStream.html#readLine%28%29), [readLong](ImageInputStream.html#readLong%28%29), [readShort](ImageInputStream.html#readShort%28%29), [readUnsignedByte](ImageInputStream.html#readUnsignedByte%28%29), [readUnsignedInt](ImageInputStream.html#readUnsignedInt%28%29), [readUnsignedShort](ImageInputStream.html#readUnsignedShort%28%29), [readUTF](ImageInputStream.html#readUTF%28%29), [seek](ImageInputStream.html#seek%28long%29), [setBitOffset](ImageInputStream.html#setBitOffset%28int%29), [setByteOrder](ImageInputStream.html#setByteOrder%28java.nio.ByteOrder%29)
Constructor Details
FileImageInputStream
Constructs a
FileImageInputStream
that will read from a givenFile
.
The file contents must not change between the time this object is constructed and the time of the last call to a read method.
Parameters:
f
- aFile
to read from.
Throws:
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")
- iff
isnull
.
[SecurityException](../../../../java.base/java/lang/SecurityException.html "class in java.lang")
- if a security manager exists and does not allow read access to the file.
[FileNotFoundException](../../../../java.base/java/io/FileNotFoundException.html "class in java.io")
- iff
is a directory or cannot be opened for reading for any other reason.
[IOException](../../../../java.base/java/io/IOException.html "class in java.io")
- if an I/O error occurs.FileImageInputStream
Constructs a
FileImageInputStream
that will read from a givenRandomAccessFile
.
The file contents must not change between the time this object is constructed and the time of the last call to a read method.
Parameters:
raf
- aRandomAccessFile
to read from.
Throws:
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")
- ifraf
isnull
.Method Details
length
public long length()
Returns the length of the underlying file, or-1
if it is unknown.
Specified by:
[length](ImageInputStream.html#length%28%29)
in interface[ImageInputStream](ImageInputStream.html "interface in javax.imageio.stream")
Overrides:
[length](ImageInputStreamImpl.html#length%28%29)
in class[ImageInputStreamImpl](ImageInputStreamImpl.html "class in javax.imageio.stream")
Returns:
the file length as along
, or-1
.finalize
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](ImageInputStreamImpl.html#finalize%28%29)
in class[ImageInputStreamImpl](ImageInputStreamImpl.html "class in javax.imageio.stream")
Throws:
[Throwable](../../../../java.base/java/lang/Throwable.html "class in java.lang")
- if an error occurs during superclass finalization.
See Also:
WeakReference, PhantomReference