All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.io.FileInputStream

java.lang.Object
   |
   +----java.io.InputStream
           |
           +----java.io.FileInputStream

public class FileInputStream
extends InputStream
A file input stream is an input stream for reading data from a File or from a FileDescriptor.

See Also:
File, FileDescriptor, FileOutputStream

Constructor Index

 o FileInputStream(File)
Creates an input file stream to read from the specified File object.
 o FileInputStream(FileDescriptor)
Creates an input file stream to read from the specified file descriptor.
 o FileInputStream(String)
Creates an input file stream to read from a file with the specified name.

Method Index

 o available()
Returns the number of bytes that can be read from this file input stream without blocking.
 o close()
Closes this file input stream and releases any system resources associated with the stream.
 o finalize()
Ensures that the close method of this file input stream is called when there are no more references to it.
 o getFD()
Returns the opaque file descriptor object associated with this stream.
 o read()
Reads a byte of data from this input stream.
 o read(byte[])
Reads up to b.length bytes of data from this input stream into an array of bytes.
 o read(byte[], int, int)
Reads up to len bytes of data from this input stream into an array of bytes.
 o skip(long)
Skips over and discards n bytes of data from the input stream.

Constructors

 o FileInputStream
    method FileInputStream(name=String) public Signals FileNotFoundException
Creates an input file stream to read from a file with the specified name.

Parameters:
name - the system-dependent file name.
Throws: FileNotFoundException
if the file is not found.
Throws: SecurityException
if a security manager exists, its checkRead method is called with the name argument to see if the application is allowed read access to the file.
See Also:
checkRead
 o FileInputStream
    method FileInputStream(file=File) public Signals FileNotFoundException
Creates an input file stream to read from the specified File object.

Parameters:
file - the file to be opened for reading.
Throws: FileNotFoundException
if the file is not found.
Throws: SecurityException
if a security manager exists, its checkRead method is called with the pathname of this File argument to see if the application is allowed read access to the file.
See Also:
getPath, checkRead
 o FileInputStream
    method FileInputStream(fdObj=FileDescriptor) public 
Creates an input file stream to read from the specified file descriptor.

Parameters:
fdObj - the file descriptor to be opened for reading.
Throws: SecurityException
if a security manager exists, its checkRead method is called with the file descriptor to see if the application is allowed to read from the specified file descriptor.
See Also:
checkRead

Methods

 o read
    method read() returns int public     Signals IOException
Reads a byte of data from this input stream. This method blocks if no input is yet available.

Returns:
the next byte of data, or -1 if the end of the file is reached.
Throws: IOException
if an I/O error occurs.
Overrides:
read in class InputStream
 o read
    method read(b=byte[]) returns int public     Signals IOException
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 - the buffer into which the data is read.
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.
Throws: IOException
if an I/O error occurs.
Overrides:
read in class InputStream
 o read
    method read(b=byte[], -
                off=int, -
                len=int) returns int public     Signals IOException
Reads up to len bytes of data from this input stream into an array of bytes. This method blocks until some input is available.

Parameters:
b - the buffer into which the data is read.
off - the start offset of the data.
len - the maximum number of bytes read.
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.
Throws: IOException
if an I/O error occurs.
Overrides:
read in class InputStream
 o skip
    method skip(n=long) returns long public     Signals IOException
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. The actual number of bytes skipped is returned.

Parameters:
n - the number of bytes to be skipped.
Returns:
the actual number of bytes skipped.
Throws: IOException
if an I/O error occurs.
Overrides:
skip in class InputStream
 o available
    method available() returns int public     Signals IOException
Returns the number of bytes that can be read from this file input stream without blocking.

Returns:
the number of bytes that can be read from this file input stream without blocking.
Throws: IOException
if an I/O error occurs.
Overrides:
available in class InputStream
 o close
    method close()  public     Signals IOException
Closes this file input stream and releases any system resources associated with the stream.

Throws: IOException
if an I/O error occurs.
Overrides:
close in class InputStream
 o getFD
    method getFD() returns FileDescriptor public   final  Signals IOException
Returns the opaque file descriptor object associated with this stream.

Returns:
the file descriptor object associated with this stream.
Throws: IOException
if an I/O error occurs.
See Also:
FileDescriptor
 o finalize
    method finalize()  Inheritable     Signals IOException
Ensures that the close method of this file input stream is called when there are no more references to it.

Throws: IOException
if an I/O error occurs.
Overrides:
finalize in class Object
See Also:
close

All Packages  Class Hierarchy  This Package  Previous  Next  Index