FileInputStream

A <code>FileInputStream</code> obtains input bytes from a file in a file system. What files are available depends on the host environment.

<p><code>FileInputStream</code> is meant for reading streams of raw bytes such as image data. For reading streams of characters, consider using <code>FileReader</code>.

@apiNote To release resources used by this stream {@link #close} should be called directly or by try-with-resources. Subclasses are responsible for the cleanup of resources acquired by the subclass. Subclasses that override {@link #finalize} in order to perform cleanup should be modified to use alternative cleanup mechanisms such as {@link java.lang.ref.Cleaner} and remove the overriding {@code finalize} method.

@implSpec If this FileInputStream has been subclassed and the {@link #close} method has been overridden, the {@link #close} method will be called when the FileInputStream is unreachable. Otherwise, it is implementation specific how the resource cleanup described in {@link #close} is performed.

More...

Constructors

this
this(string name)

Creates a <code>FileInputStream</code> by opening a connection to an actual file, the file named by the path name <code>name</code> in the file system. A new <code>FileDescriptor</code> object is created to represent this file connection. <p> First, if there is a security manager, its <code>checkRead</code> method is called with the <code>name</code> argument as its argument. <p> If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a <code>FileNotFoundException</code> is thrown.

this
this(File file)

Creates a <code>FileInputStream</code> by opening a connection to an actual file, the file named by the <code>File</code> object <code>file</code> in the file system. A new <code>FileDescriptor</code> object is created to represent this file connection. <p> First, if there is a security manager, its <code>checkRead</code> method is called with the path represented by the <code>file</code> argument as its argument. <p> If the named file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading then a <code>FileNotFoundException</code> is thrown.

Members

Functions

available
int available()

Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. Returns 0 when the file position is beyond EOF. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

close
void close()

Closes this file input stream and releases any system resources associated with the stream.

read
int read()

Reads a byte of data from this input stream. This method blocks if no input is yet available.

read
int read(byte[] b)

Reads up to <code>b.length</code> bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

read
int read(byte[] b, int off, int len)

Reads up to <code>len</code> bytes of data from this input stream into an array of bytes. If <code>len</code> is not zero, the method blocks until some input is available; otherwise, no bytes are read and <code>0</code> is returned.

skip
long skip(long n)

Skips over and discards <code>n</code> bytes of data from the input stream.

Inherited Members

From InputStream

read
int read()

Reads the next byte of data from the input stream. The value byte is returned as an <code>int</code> in the range <code>0</code> to <code>255</code>. If no byte is available because the end of the stream has been reached, the value <code>-1</code> is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

read
int read(byte[] b)

Reads some number of bytes from the input stream and stores them into the buffer array <code>b</code>. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown.

read
int read(byte[] b, int off, int len)

Reads up to <code>len</code> bytes of data from the input stream into an array of bytes. An attempt is made to read as many as <code>len</code> bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

skip
long skip(long n)

Skips over and discards <code>n</code> bytes of data from this input stream. The <code>skip</code> method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly <code>0</code>. This may result from any of a number of conditions; reaching end of file before <code>n</code> bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If {@code n} is negative, the {@code skip} method for class {@code InputStream} always returns 0, and no bytes are skipped. Subclasses may handle the negative value differently.

available
int available()

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

close
void close()

Closes this input stream and releases any system resources associated with the stream.

mark
void mark(int readlimit)

Marks the current position in this input stream. A subsequent call to the <code>reset</code> method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

reset
void reset()

Repositions this stream to the position at the time the <code>mark</code> method was last called on this input stream.

position
void position(int index)

set a new position

markSupported
bool markSupported()

Tests if this input stream supports the <code>mark</code> and <code>reset</code> methods. Whether or not <code>mark</code> and <code>reset</code> are supported is an invariant property of a particular input stream instance. The <code>markSupported</code> method of <code>InputStream</code> returns <code>false</code>.

Detailed Description

@author Arthur van Hoff @see java.io.File @see java.io.FileDescriptor @see java.io.FileOutputStream @see java.nio.file.Files#newInputStream

Meta