- java.lang.Object
-
- java.io.InputStream
-
- java.io.FileInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class FileInputStream extends InputStream
AFileInputStream
obtains input bytes from a file in a file system. What files are available depends on the host environment.FileInputStream
is meant for reading streams of raw bytes such as image data. For reading streams of characters, consider usingFileReader
.- Since:
- JDK1.0
- See Also:
File
,FileDescriptor
,FileOutputStream
,Files.newInputStream(java.nio.file.Path, java.nio.file.OpenOption...)
-
-
Constructor Summary
Constructors Constructor and Description FileInputStream(File file)
Creates aFileInputStream
by opening a connection to an actual file, the file named by theFile
objectfile
in the file system.FileInputStream(FileDescriptor fdObj)
Creates aFileInputStream
by using the file descriptorfdObj
, which represents an existing connection to an actual file in the file system.FileInputStream(String name)
Creates aFileInputStream
by opening a connection to an actual file, the file named by the path namename
in the file system.
-
Method Summary
Methods Modifier and Type Method and Description 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.void
close()
Closes this file input stream and releases any system resources associated with the stream.protected void
finalize()
Ensures that theclose
method of this file input stream is called when there are no more references to it.FileChannel
getChannel()
Returns the uniqueFileChannel
object associated with this file input stream.FileDescriptor
getFD()
Returns theFileDescriptor
object that represents the connection to the actual file in the file system being used by thisFileInputStream
.int
read()
Reads a byte of data from this input stream.int
read(byte[] b)
Reads up tob.length
bytes of data from this input stream into an array of bytes.int
read(byte[] b, int off, int len)
Reads up tolen
bytes of data from this input stream into an array of bytes.long
skip(long n)
Skips over and discardsn
bytes of data from the input stream.-
Methods inherited from class java.io.InputStream
mark, markSupported, reset
-
-
-
-
Constructor Detail
-
FileInputStream
public FileInputStream(String name) throws FileNotFoundException
Creates aFileInputStream
by opening a connection to an actual file, the file named by the path namename
in the file system. A newFileDescriptor
object is created to represent this file connection.First, if there is a security manager, its
checkRead
method is called with thename
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
- the system-dependent file name.- Throws:
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 itscheckRead
method denies read access to the file.- See Also:
SecurityManager.checkRead(java.lang.String)
-
FileInputStream
public FileInputStream(File file) throws FileNotFoundException
Creates aFileInputStream
by opening a connection to an actual file, the file named by theFile
objectfile
in the file system. A newFileDescriptor
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 thefile
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
- the file to be opened for reading.- Throws:
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 itscheckRead
method denies read access to the file.- See Also:
File.getPath()
,SecurityManager.checkRead(java.lang.String)
-
FileInputStream
public FileInputStream(FileDescriptor fdObj)
Creates aFileInputStream
by using the file descriptorfdObj
, 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 descriptorfdObj
as its argument to see if it's ok to read the file descriptor. If read access is denied to the file descriptor aSecurityException
is thrown.If
fdObj
is null then aNullPointerException
is thrown.This constructor does not throw an exception if
fdObj
isinvalid
. However, if the methods are invoked on the resulting stream to attempt I/O on the stream, anIOException
is thrown.- Parameters:
fdObj
- the file descriptor to be opened for reading.- Throws:
SecurityException
- if a security manager exists and itscheckRead
method denies read access to the file descriptor.- See Also:
SecurityManager.checkRead(java.io.FileDescriptor)
-
-
Method Detail
-
read
public int read() throws IOException
Reads a byte of data from this input stream. This method blocks if no input is yet available.- Specified by:
read
in classInputStream
- Returns:
- the next byte of data, or
-1
if the end of the file is reached. - Throws:
IOException
- if an I/O error occurs.
-
read
public int read(byte[] b) throws IOException
Reads up tob.length
bytes of data from this input stream into an array of bytes. This method blocks until some input is available.- Overrides:
read
in classInputStream
- 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.- See Also:
InputStream.read(byte[], int, int)
-
read
public int read(byte[] b, int off, int len) throws IOException
Reads up tolen
bytes of data from this input stream into an array of bytes. Iflen
is not zero, the method blocks until some input is available; otherwise, no bytes are read and0
is returned.- Overrides:
read
in classInputStream
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in the destination arrayb
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:
NullPointerException
- Ifb
isnull
.IndexOutOfBoundsException
- Ifoff
is negative,len
is negative, orlen
is greater thanb.length - off
IOException
- if an I/O error occurs.- See Also:
InputStream.read()
-
skip
public long skip(long n) throws IOException
Skips over and discardsn
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, possibly0
. Ifn
is negative, anIOException
is thrown, even though theskip
method of theInputStream
superclass does nothing in this case. The actual number of bytes skipped is returned.This method may skip more bytes than 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.
- Overrides:
skip
in classInputStream
- Parameters:
n
- the number of bytes to be skipped.- Returns:
- the actual number of bytes skipped.
- Throws:
IOException
- if n is negative, if the stream does not support seek, or if an I/O error occurs.
-
available
public int available() throws IOException
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. 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.
- Overrides:
available
in classInputStream
- Returns:
- an estimate of the number of remaining bytes that can be read (or skipped over) from this input stream without blocking.
- Throws:
IOException
- if this file input stream has been closed by callingclose
or an I/O error occurs.
-
close
public void close() throws IOException
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.
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- if an I/O error occurs.
-
getFD
public final FileDescriptor getFD() throws IOException
Returns theFileDescriptor
object that represents the connection to the actual file in the file system being used by thisFileInputStream
.- Returns:
- the file descriptor object associated with this stream.
- Throws:
IOException
- if an I/O error occurs.- See Also:
FileDescriptor
-
getChannel
public FileChannel getChannel()
Returns the uniqueFileChannel
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:
- the file channel associated with this file input stream
- Since:
- 1.4
-
finalize
protected void finalize() throws IOException
Ensures that theclose
method of this file input stream is called when there are no more references to it.- Overrides:
finalize
in classObject
- Throws:
IOException
- if an I/O error occurs.- See Also:
close()
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
05/11/2024 15:57:00 Cette version de la page est en cache (à la date du 05/11/2024 15:57:00) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 30/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/io/FileInputStream.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.