Class FileInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.FileInputStream
-
- All Implemented Interfaces:
Closeable,AutoCloseable
- Direct Known Subclasses:
ParcelFileDescriptor.AutoCloseInputStream
public class FileInputStream extends InputStream
An input stream that reads bytes from a file.File file = ... InputStream in = null; try { in = new BufferedInputStream(new FileInputStream(file)); ... } finally { if (in != null) { in.close(); } }This stream is not buffered. Most callers should wrap this stream with a
BufferedInputStream.Use
FileReaderto read characters, as opposed to bytes, from a file.- See Also:
BufferedInputStream,FileOutputStream
-
-
Constructor Summary
Constructors Constructor Description FileInputStream(File file)Constructs a newFileInputStreamthat reads fromfile.FileInputStream(FileDescriptor fd)Constructs a newFileInputStreamthat reads fromfd.FileInputStream(String path)Equivalent tonew FileInputStream(new File(path)).
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intavailable()Returns an estimated number of bytes that can be read or skipped without blocking for more input.voidclose()Closes this stream.protected voidfinalize()Ensures that all resources for this stream are released when it is about to be garbage collected.FileChannelgetChannel()Returns a read-onlyFileChannelthat shares its position with this stream.FileDescriptorgetFD()Returns the underlying file descriptor.intread()Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.intread(byte[] buffer, int byteOffset, int byteCount)Reads up tobyteCountbytes from this stream and stores them in the byte arraybufferstarting atbyteOffset.longskip(long byteCount)Skips at mostbyteCountbytes in this stream.-
Methods inherited from class java.io.InputStream
mark, markSupported, read, reset
-
-
-
-
Constructor Detail
-
FileInputStream
public FileInputStream(File file) throws FileNotFoundException
Constructs a newFileInputStreamthat reads fromfile.- Parameters:
file- the file from which this stream reads.- Throws:
FileNotFoundException- iffiledoes not exist.
-
FileInputStream
public FileInputStream(FileDescriptor fd)
Constructs a newFileInputStreamthat reads fromfd.- Parameters:
fd- the FileDescriptor from which this stream reads.- Throws:
NullPointerException- iffdisnull.
-
FileInputStream
public FileInputStream(String path) throws FileNotFoundException
Equivalent tonew FileInputStream(new File(path)).- Throws:
FileNotFoundException
-
-
Method Detail
-
available
public int available() throws IOExceptionDescription copied from class:InputStreamReturns an estimated number of bytes that can be read or skipped without blocking for more input.Note that this method provides such a weak guarantee that it is not very useful in practice.
Firstly, the guarantee is "without blocking for more input" rather than "without blocking": a read may still block waiting for I/O to complete — the guarantee is merely that it won't have to wait indefinitely for data to be written. The result of this method should not be used as a license to do I/O on a thread that shouldn't be blocked.
Secondly, the result is a conservative estimate and may be significantly smaller than the actual number of bytes available. In particular, an implementation that always returns 0 would be correct. In general, callers should only use this method if they'd be satisfied with treating the result as a boolean yes or no answer to the question "is there definitely data ready?".
Thirdly, the fact that a given number of bytes is "available" does not guarantee that a read or skip will actually read or skip that many bytes: they may read or skip fewer.
It is particularly important to realize that you must not use this method to size a container and assume that you can read the entirety of the stream without needing to resize the container. Such callers should probably write everything they read to a
ByteArrayOutputStreamand convert that to a byte array. Alternatively, if you're reading from a file,File.length()returns the current length of the file (though assuming the file's length can't change may be incorrect, reading a file is inherently racy).The default implementation of this method in
InputStreamalways returns 0. Subclasses should override this method if they are able to indicate the number of bytes available.- Overrides:
availablein classInputStream- Returns:
- the estimated number of bytes available
- Throws:
IOException- if this stream is closed or an error occurs
-
close
public void close() throws IOExceptionDescription copied from class:InputStreamCloses this stream. Concrete implementations of this class should free any resources during close. This implementation does nothing.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classInputStream- Throws:
IOException- if an error occurs while closing this stream.
-
finalize
protected void finalize() throws IOExceptionEnsures that all resources for this stream are released when it is about to be garbage collected.- Overrides:
finalizein classObject- Throws:
IOException- if an error occurs attempting to finalize this stream.
-
getChannel
public FileChannel getChannel()
Returns a read-onlyFileChannelthat shares its position with this stream.
-
getFD
public final FileDescriptor getFD() throws IOException
Returns the underlying file descriptor.- Throws:
IOException
-
read
public int read() throws IOExceptionDescription copied from class:InputStreamReads a single byte from this stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the stream has been reached. Blocks until one byte has been read, the end of the source stream is detected or an exception is thrown.- Specified by:
readin classInputStream- Throws:
IOException- if the stream is closed or another IOException occurs.
-
read
public int read(byte[] buffer, int byteOffset, int byteCount) throws IOExceptionDescription copied from class:InputStreamReads up tobyteCountbytes from this stream and stores them in the byte arraybufferstarting atbyteOffset. Returns the number of bytes actually read or -1 if the end of the stream has been reached.- Overrides:
readin classInputStream- Throws:
IOException- if the stream is closed or another IOException occurs.
-
skip
public long skip(long byteCount) throws IOExceptionDescription copied from class:InputStreamSkips at mostbyteCountbytes in this stream. The number of actual bytes skipped may be anywhere between 0 andbyteCount. IfbyteCountis negative, this method does nothing and returns 0, but some subclasses may throw.Note the "at most" in the description of this method: this method may choose to skip fewer bytes than requested. Callers should always check the return value.
This default implementation reads bytes into a temporary buffer. Concrete subclasses should provide their own implementation.
- Overrides:
skipin classInputStream- Returns:
- the number of bytes actually skipped.
- Throws:
IOException- if this stream is closed or another IOException occurs.
-
-