OpenJDK 1.22 · java.io.FileInputStream · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private volatile FileChannel	channel
private volatile boolean	closed
private final Object	closeLock
private static final int	DEFAULT_BUFFER_SIZE Hides java.io.InputStream.DEFAULT_BUFFER_SIZE.
private final FileDescriptor	fd
private final String	path The path of the referenced file (null if the stream is created with a file descriptor)

Access	Constructor and Description
public	FileInputStream(String the system-dependent file name. name) Creates a `FileInputStream` by opening a connection to an actual file, the file named by the path name `name` in the file system.
public	FileInputStream(File the file to be opened for reading. file) Creates a `FileInputStream` by opening a connection to an actual file, the file named by the `File` object `file` in the file system.
public	FileInputStream(FileDescriptor the file descriptor to be opened for reading. fdObj) Creates a `FileInputStream` by using the file descriptor `fdObj`, which represents an existing connection to an actual file in the file system.

Method Summary

Modifier and Type	Method and Description
public int	Returns: an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking. available() Overrides java.io.InputStream.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.
private native int	available0()
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this file input stream and releases any system resources associated with the stream.
public FileChannel	Returns: the file channel associated with this file input stream getChannel() Returns the unique `FileChannel` object associated with this file input stream.
public final FileDescriptor	Returns: the file descriptor object associated with this stream. getFD() Returns the `FileDescriptor` object that represents the connection to the actual file in the file system being used by this `FileInputStream`.
private static native void	initIDs()
private long	length()
private native long	length0()
private void	open(String the name of the file name) Opens the specified file for reading.
private native void	open0(String the name of the file name) Opens the specified file for reading.
private long	position()
private native long	position0()
public int	Returns: the next byte of data, or `-1` if the end of the file is reached. read() Implements abstract java.io.InputStream.read. Reads a byte of data from this input stream.
public int	Returns: the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the file has been reached. read(byte[] the buffer into which the data is read. b) Overrides java.io.InputStream.read. Reads up to `b.length` bytes of data from this input stream into an array of bytes.
public int	Returns: the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
private native int	read0()
public byte[]	readAllBytes() Overrides java.io.InputStream.readAllBytes. Reads all remaining bytes from the input stream.
private native int	readBytes(byte[] the data to be written b, int the start offset in the data off, int the number of bytes that are written len) Reads a subarray as a sequence of bytes.
public byte[]	readNBytes(int the maximum number of bytes to read len) Overrides java.io.InputStream.readNBytes. Reads up to a specified number of bytes from the input stream.
public long	Returns: the actual number of bytes skipped. skip(long the number of bytes to be skipped. n) Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from the input stream.
private native long	skip0(long n)
public long	transferTo(OutputStream the output stream, non-null out) Overrides java.io.InputStream.transferTo. Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read.

Inherited from java.io.InputStream:: mark markSupported nullInputStream readNBytes reset skipNBytes

Field Detail

channel	back to summary
private volatile FileChannel channel

closed	back to summary
private volatile boolean closed

closeLock	back to summary
private final Object closeLock

DEFAULT_BUFFER_SIZE	back to summary
private static final int DEFAULT_BUFFER_SIZE Hides java.io.InputStream.DEFAULT_BUFFER_SIZE.

fd	back to summary
private final FileDescriptor fd

path	back to summary
private final String path The path of the referenced file (null if the stream is created with a file descriptor)

Constructor Detail

FileInputStream back to summary

FileInputStream	back to summary
public FileInputStream(String name) throws FileNotFoundException Creates a `FileInputStream` by opening a connection to an actual file, the file named by the path name `name` in the file system. A new `FileDescriptor` object is created to represent this file connection. First, if there is a security manager, its `checkRead` method is called with the `name` argument as its argument. 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 `FileNotFoundException` is thrown. Parameters name:String the system-dependent file name. Exceptions FileNotFoundException: if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading. SecurityException: if a security manager exists and its `checkRead` method denies read access to the file. See Also `java.lang.SecurityManager#checkRead(java.lang.String)`

public FileInputStream(String name) throws FileNotFoundException

Creates a FileInputStream by opening a connection to an actual file, the file named by the path name name in the file system. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkRead method is called with the name argument as its argument.

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 FileNotFoundException is thrown.

Parameters

name:String: the system-dependent file name.

Exceptions

FileNotFoundException:: if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading.
SecurityException:: if a security manager exists and its checkRead method denies read access to the file.

FileInputStream back to summary

FileInputStream	back to summary
public FileInputStream(File file) throws FileNotFoundException Creates a `FileInputStream` by opening a connection to an actual file, the file named by the `File` object `file` in the file system. A new `FileDescriptor` object is created to represent this file connection. First, if there is a security manager, its `checkRead` method is called with the path represented by the `file` argument as its argument. 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 `FileNotFoundException` is thrown. Parameters file:File the file to be opened for reading. Exceptions FileNotFoundException: if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading. SecurityException: if a security manager exists and its `checkRead` method denies read access to the file. See Also `java.io.File#getPath()`, `java.lang.SecurityManager#checkRead(java.lang.String)`

public FileInputStream(File file) throws FileNotFoundException

Creates a FileInputStream by opening a connection to an actual file, the file named by the File object file in the file system. A new FileDescriptor object is created to represent this file connection.

First, if there is a security manager, its checkRead method is called with the path represented by the file argument as its argument.

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 FileNotFoundException is thrown.

Parameters

file:File: the file to be opened for reading.

Exceptions

FileNotFoundException:: if the file does not exist, is a directory rather than a regular file, or for some other reason cannot be opened for reading.
SecurityException:: if a security manager exists and its checkRead method denies read access to the file.

FileInputStream back to summary

FileInputStream	back to summary
public FileInputStream(FileDescriptor fdObj) Creates a `FileInputStream` by using the file descriptor `fdObj`, which represents an existing connection to an actual file in the file system. If there is a security manager, its `checkRead` method is called with the file descriptor `fdObj` as its argument to see if it's ok to read the file descriptor. If read access is denied to the file descriptor a `SecurityException` is thrown. If `fdObj` is null then a `NullPointerException` is thrown. This constructor does not throw an exception if `fdObj` is `invalid`. However, if the methods are invoked on the resulting stream to attempt I/O on the stream, an `IOException` is thrown. Parameters fdObj:FileDescriptor the file descriptor to be opened for reading. Exceptions SecurityException: if a security manager exists and its `checkRead` method denies read access to the file descriptor. See Also `SecurityManager#checkRead(java.io.FileDescriptor)`

public FileInputStream(FileDescriptor fdObj)

Creates a FileInputStream by using the file descriptor fdObj, which represents an existing connection to an actual file in the file system.

If there is a security manager, its checkRead method is called with the file descriptor fdObj as its argument to see if it's ok to read the file descriptor. If read access is denied to the file descriptor a SecurityException is thrown.

If fdObj is null then a NullPointerException is thrown.

This constructor does not throw an exception if fdObj is invalid. However, if the methods are invoked on the resulting stream to attempt I/O on the stream, an IOException is thrown.

Parameters

fdObj:FileDescriptor: the file descriptor to be opened for reading.

Exceptions

SecurityException:: if a security manager exists and its checkRead method denies read access to the file descriptor.

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.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. In some cases, a non-blocking read (or skip) may appear to be blocked when it is merely slow, for example when reading large files over slow networks. Returns:int an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking. Annotations @Override Exceptions IOException: if this file input stream has been closed by calling `close` or an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.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.

In some cases, a non-blocking read (or skip) may appear to be blocked when it is merely slow, for example when reading large files over slow networks.

Returns:int

an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking.

Annotations

@Override

Exceptions

IOException:: if this file input stream has been closed by calling close or an I/O error occurs.

available0	back to summary
private native int available0() throws IOException

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this file input stream and releases any system resources associated with the stream. If this stream has an associated channel then the channel is closed as well. API Note Overriding `close` to perform cleanup actions is reliable only when called directly or when called by try-with-resources. Implementation Specification Subclasses requiring that resource cleanup take place after a stream becomes unreachable should use the `java.lang.ref.Cleaner` mechanism. If this stream has an associated channel then this method will close the channel, which in turn will close this stream. Subclasses that override this method should be prepared to handle possible reentrant invocation. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

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

If this stream has an associated channel then the channel is closed as well.

API Note

Overriding close to perform cleanup actions is reliable only when called directly or when called by try-with-resources.

Implementation Specification

Subclasses requiring that resource cleanup take place after a stream becomes unreachable should use the java.lang.ref.Cleaner mechanism.

If this stream has an associated channel then this method will close the channel, which in turn will close this stream. Subclasses that override this method should be prepared to handle possible reentrant invocation.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getChannel back to summary

getChannel	back to summary
public FileChannel getChannel() Returns the unique `FileChannel` object associated with this file input stream. The initial `position` of the returned channel will be equal to the number of bytes read from the file so far. Reading bytes from this stream will increment the channel's position. Changing the channel's position, either explicitly or by reading, will change this stream's file position. Returns:FileChannel the file channel associated with this file input stream Since 1.4

public FileChannel getChannel()

Returns the unique FileChannel object associated with this file input stream.

The initial position of the returned channel will be equal to the number of bytes read from the file so far. Reading bytes from this stream will increment the channel's position. Changing the channel's position, either explicitly or by reading, will change this stream's file position.

Returns:FileChannel: the file channel associated with this file input stream
Since: 1.4

getFD back to summary

getFD	back to summary
public final FileDescriptor getFD() throws IOException Returns the `FileDescriptor` object that represents the connection to the actual file in the file system being used by this `FileInputStream`. Returns:FileDescriptor the file descriptor object associated with this stream. Exceptions IOException: if an I/O error occurs. See Also `java.io.FileDescriptor`

public final FileDescriptor getFD() throws IOException

Returns the FileDescriptor object that represents the connection to the actual file in the file system being used by this FileInputStream.

Returns:FileDescriptor

the file descriptor object associated with this stream.

Exceptions

IOException:: if an I/O error occurs.

See Also

java.io.FileDescriptor

initIDs	back to summary
private static native void initIDs()

length	back to summary
private long length() throws IOException

length0	back to summary
private native long length0() throws IOException

open	back to summary
private void open(String name) throws FileNotFoundException Opens the specified file for reading. Parameters name:String the name of the file

open

back to summary

private void open(String name) throws FileNotFoundException

Opens the specified file for reading.

Parameters

name:String: the name of the file

open0	back to summary
private native void open0(String name) throws FileNotFoundException Opens the specified file for reading. Parameters name:String the name of the file

open0

back to summary

private native void open0(String name) throws FileNotFoundException

Opens the specified file for reading.

Parameters

name:String: the name of the file

position	back to summary
private long position() throws IOException

position0	back to summary
private native long position0() throws IOException

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Reads a byte of data from this input stream. This method blocks if no input is yet available. Returns:int the next byte of data, or `-1` if the end of the file is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

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

Returns:int

the next byte of data, or -1 if the end of the file is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b) throws IOException Overrides java.io.InputStream.read. Reads up to `b.length` bytes of data from this input stream into an array of bytes. This method blocks until some input is available. Parameters b:byte[] Doc from java.io.InputStream.read. the buffer into which the data is read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the file has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read(byte[] b) throws IOException

Overrides java.io.InputStream.read.

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

Parameters

b:byte[]

Doc from java.io.InputStream.read.

the buffer into which the data is read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the file has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.InputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. Parameters b:byte[] Doc from java.io.InputStream.read. the buffer into which the data is read. off:int Doc from java.io.InputStream.read. the start offset in array `b` at which the data is written. len:int Doc from java.io.InputStream.read. the maximum number of bytes to read. Returns:int Doc from java.io.InputStream.read. the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs. NullPointerException: If `b` is `null`. IndexOutOfBoundsException: If `off` is negative, `len` is negative, or `len` is greater than `b.length - off`

public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.InputStream.read.

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

Parameters

b:byte[]

Doc from java.io.InputStream.read.

the buffer into which the data is read.

off:int

Doc from java.io.InputStream.read.

the start offset in array b at which the data is written.

len:int

Doc from java.io.InputStream.read.

the maximum number of bytes to read.

Returns:int

Doc from java.io.InputStream.read.

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.
NullPointerException:: If b is null.
IndexOutOfBoundsException:: If off is negative, len is negative, or len is greater than b.length - off

read0	back to summary
private native int read0() throws IOException

readAllBytes	back to summary
public byte[] readAllBytes() throws IOException Overrides java.io.InputStream.readAllBytes. Doc from java.io.InputStream.readAllBytes. Reads all remaining bytes from the input stream. This method blocks until all remaining bytes have been read and end of stream is detected, or an exception is thrown. This method does not close the input stream. When this stream reaches end of stream, further invocations of this method will return an empty byte array. Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading input streams with large amounts of data. The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified. If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs. Returns:byte[] a byte array containing the bytes read from this input stream Annotations @Override Exceptions IOException: if an I/O error occurs

readAllBytes

back to summary

public byte[] readAllBytes() throws IOException

Overrides java.io.InputStream.readAllBytes.

Doc from java.io.InputStream.readAllBytes.

Reads all remaining bytes from the input stream. This method blocks until all remaining bytes have been read and end of stream is detected, or an exception is thrown. This method does not close the input stream.

When this stream reaches end of stream, further invocations of this method will return an empty byte array.

Note that this method is intended for simple cases where it is convenient to read all bytes into a byte array. It is not intended for reading input streams with large amounts of data.

The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.

If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs.

Returns:byte[]

a byte array containing the bytes read from this input stream

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

readBytes	back to summary
private native int readBytes(byte[] b, int off, int len) throws IOException Reads a subarray as a sequence of bytes. Parameters b:byte[] the data to be written off:int the start offset in the data len:int the number of bytes that are written Exceptions IOException: If an I/O error has occurred.

readBytes

back to summary

private native int readBytes(byte[] b, int off, int len) throws IOException

Reads a subarray as a sequence of bytes.

Parameters

b:byte[]: the data to be written
off:int: the start offset in the data
len:int: the number of bytes that are written

Exceptions

IOException:: If an I/O error has occurred.

readNBytes back to summary

readNBytes	back to summary
public byte[] readNBytes(int len) throws IOException Overrides java.io.InputStream.readNBytes. Doc from java.io.InputStream.readNBytes. Reads up to a specified number of bytes from the input stream. This method blocks until the requested number of bytes has been read, end of stream is detected, or an exception is thrown. This method does not close the input stream. The length of the returned array equals the number of bytes read from the stream. If `len` is zero, then no bytes are read and an empty byte array is returned. Otherwise, up to `len` bytes are read from the stream. Fewer than `len` bytes may be read if end of stream is encountered. When this stream reaches end of stream, further invocations of this method will return an empty byte array. Note that this method is intended for simple cases where it is convenient to read the specified number of bytes into a byte array. The total amount of memory allocated by this method is proportional to the number of bytes read from the stream which is bounded by `len`. Therefore, the method may be safely called with very large values of `len` provided sufficient memory is available. The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified. If an I/O error occurs reading from the input stream, then it may do so after some, but not all, bytes have been read. Consequently the input stream may not be at end of stream and may be in an inconsistent state. It is strongly recommended that the stream be promptly closed if an I/O error occurs. Parameters len:int the maximum number of bytes to read Returns:byte[] a byte array containing the bytes read from this input stream Annotations @Override Exceptions IOException: if an I/O error occurs

public byte[] readNBytes(int len) throws IOException

Overrides java.io.InputStream.readNBytes.

Doc from java.io.InputStream.readNBytes.

Reads up to a specified number of bytes from the input stream. This method blocks until the requested number of bytes has been read, end of stream is detected, or an exception is thrown. This method does not close the input stream.

The length of the returned array equals the number of bytes read from the stream. If len is zero, then no bytes are read and an empty byte array is returned. Otherwise, up to len bytes are read from the stream. Fewer than len bytes may be read if end of stream is encountered.

When this stream reaches end of stream, further invocations of this method will return an empty byte array.

Note that this method is intended for simple cases where it is convenient to read the specified number of bytes into a byte array. The total amount of memory allocated by this method is proportional to the number of bytes read from the stream which is bounded by len. Therefore, the method may be safely called with very large values of len provided sufficient memory is available.

The behavior for the case where the input stream is asynchronously closed, or the thread interrupted during the read, is highly input stream specific, and therefore not specified.

Parameters

len:int: the maximum number of bytes to read

Returns:byte[]

a byte array containing the bytes read from this input stream

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.InputStream.skip. Skips over and discards `n` bytes of data from the input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. If `n` is negative, the method will try to skip backwards. In case the backing file does not support backward skip at its current position, an `IOException` is thrown. The actual number of bytes skipped is returned. If it skips forwards, it returns a positive value. If it skips backwards, it returns a negative value. This method may skip more bytes than what are remaining in the backing file. This produces no exception and the number of bytes skipped may include some number of bytes that were beyond the EOF of the backing file. Attempting to read from the stream after skipping past the end will result in -1 indicating the end of the file. Parameters n:long Doc from java.io.InputStream.skip. the number of bytes to be skipped. Returns:long the actual number of bytes skipped. Annotations @Override Exceptions IOException: if n is negative, if the stream does not support seek, or if an I/O error occurs.

public long skip(long n) throws IOException

Overrides java.io.InputStream.skip.

Skips over and discards n bytes of data from the input stream.

The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. If n is negative, the method will try to skip backwards. In case the backing file does not support backward skip at its current position, an IOException is thrown. The actual number of bytes skipped is returned. If it skips forwards, it returns a positive value. If it skips backwards, it returns a negative value.

This method may skip more bytes than what are remaining in the backing file. This produces no exception and the number of bytes skipped may include some number of bytes that were beyond the EOF of the backing file. Attempting to read from the stream after skipping past the end will result in -1 indicating the end of the file.

Parameters

n:long

Doc from java.io.InputStream.skip.

the number of bytes to be skipped.

Returns:long

the actual number of bytes skipped.

Annotations

@Override

Exceptions

IOException:: if n is negative, if the stream does not support seek, or if an I/O error occurs.

skip0	back to summary
private native long skip0(long n) throws IOException

transferTo back to summary

transferTo	back to summary
public long transferTo(OutputStream out) throws IOException Overrides java.io.InputStream.transferTo. Doc from java.io.InputStream.transferTo. Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. On return, this input stream will be at end of stream. This method does not close either stream. This method may block indefinitely reading from the input stream, or writing to the output stream. The behavior for the case where the input and/or output stream is asynchronously closed, or the thread interrupted during the transfer, is highly input and output stream specific, and therefore not specified. If the total number of bytes transferred is greater than Long#MAX_VALUE, then `Long.MAX_VALUE` will be returned. If an I/O error occurs reading from the input stream or writing to the output stream, then it may do so after some bytes have been read or written. Consequently the input stream may not be at end of stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs. Parameters out:OutputStream the output stream, non-null Returns:long the number of bytes transferred Annotations @Override Exceptions IOException: if an I/O error occurs when reading or writing

public long transferTo(OutputStream out) throws IOException

Overrides java.io.InputStream.transferTo.

Doc from java.io.InputStream.transferTo.

Reads all bytes from this input stream and writes the bytes to the given output stream in the order that they are read. On return, this input stream will be at end of stream. This method does not close either stream.

This method may block indefinitely reading from the input stream, or writing to the output stream. The behavior for the case where the input and/or output stream is asynchronously closed, or the thread interrupted during the transfer, is highly input and output stream specific, and therefore not specified.

If the total number of bytes transferred is greater than Long#MAX_VALUE, then Long.MAX_VALUE will be returned.

If an I/O error occurs reading from the input stream or writing to the output stream, then it may do so after some bytes have been read or written. Consequently the input stream may not be at end of stream and one, or both, streams may be in an inconsistent state. It is strongly recommended that both streams be promptly closed if an I/O error occurs.

Parameters

out:OutputStream: the output stream, non-null

Returns:long

the number of bytes transferred

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs when reading or writing

public Class FileInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail