java.io
クラス FileInputStream

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

public class FileInputStream

extends InputStream

ファイルシステムのファイルから入力バイトを取得します。どのファイルが有効かはホスト環境に依存します。

導入されたバージョン:

JDK1.0

関連項目:

File, FileDescriptor, FileOutputStream

コンストラクタの概要

FileInputStream(File file)
ファイルシステムの実際のファイル (File オブジェクト file により指定) に接続することにより、FileInputStream を作成します。

FileInputStream(FileDescriptor fdObj)
ファイルシステムの実際のファイルへの既存の接続を表すファイル記述子 fdObj を使用して、FileInputStream を作成します。

FileInputStream(String name)
ファイルシステムの実際のファイル (パス名 name により指定) に接続することにより、FileInputStream を作成します。

メソッドの概要

int	available() ブロックせずにファイル入力ストリームから読み込むことができるバイト数を返します。
void	close() ファイル入力ストリームを閉じ、このストリームに関連するシステムリソースを解放します。
protected void	finalize() ファイル入力ストリームへの参照が存在しなくなったときに、このストリームの close メソッドが確実に呼び出されるようにします。
FileDescriptor	getFD() この FileInputStream に使用されているファイルシステムの実際のファイルへの接続を表す FileDescriptor オブジェクトを返します。
int	read() 入力ストリームから 1 バイトを読み込みます。
int	read(byte[] b) 入力ストリームから最大 b.length バイトをバイト配列に読み込みます。
int	read(byte[] b, int off, int len) 入力ストリームから最大 len バイトをバイト配列に読み込みます。
long	skip(long n) 入力ストリームからのデータを n バイトだけスキップして廃棄します。

クラス java.io.InputStream から継承したメソッド

mark, markSupported, reset

クラス java.lang.Object から継承したメソッド

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

FileInputStream

public FileInputStream(String name)
                throws FileNotFoundException

ファイルシステムの実際のファイル (パス名 name により指定) に接続することにより、FileInputStream を作成します。このファイルの接続を表すために、新しい FileDescriptor オブジェクトが作成されます。

まず、セキュリティマネージャが存在する場合、checkRead メソッドが name 引数を引数として呼び出されます。

指定されたファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合は、FileNotFoundException がスローされます。

パラメータ:

name - システムに依存するファイル名

例外:

FileNotFoundException - ファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で読み込みのために開くことができない場合

SecurityException - セキュリティマネージャが存在し、checkRead メソッドがファイルへの読み込みアクセスを拒否する場合

関連項目:

SecurityManager.checkRead(java.lang.String)

FileInputStream

public FileInputStream(File file)
                throws FileNotFoundException

ファイルシステムの実際のファイル (File オブジェクト file により指定) に接続することにより、FileInputStream を作成します。このファイルの接続を表すために、新しい FileDescriptor オブジェクトが作成されます。

まず、セキュリティマネージャが存在する場合、checkRead メソッドが、file 引数によって表されるパスを引数として呼び出されます。

指定されたファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合は、FileNotFoundException がスローされます。

パラメータ:

file - 読み込みのために開かれるファイル

例外:

FileNotFoundException - ファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合

SecurityException - セキュリティマネージャが存在し、その checkRead メソッドがファイルへの読み込みアクセスを拒否する場合

関連項目:

File.getPath(), SecurityManager.checkRead(java.lang.String)

FileInputStream

public FileInputStream(FileDescriptor fdObj)

ファイルシステムの実際のファイルへの既存の接続を表すファイル記述子 fdObj を使用して、FileInputStream を作成します。

まず、セキュリティマネージャが存在する場合、checkRead メソッドがファイル記述子 fdObj を引数として呼び出されます。これは、ファイル記述子を読み込めるかどうかを確認するためです。

パラメータ:

fdObj - 読み込み用に開かれるファイル記述子

例外:

SecurityException - セキュリティマネージャが存在し、checkRead メソッドがファイル記述子への読み込みアクセスを拒否する場合

関連項目:

SecurityManager.checkRead(java.io.FileDescriptor)

メソッドの詳細

read

public int read()
         throws IOException

入力ストリームから 1 バイトを読み込みます。このメソッドは、有効な入力がまだない場合はブロックします。

戻り値:

次のバイトデータ。ファイルの終わりに達した場合は -1

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス InputStream 内の read

read

public int read(byte[] b)
         throws IOException

入力ストリームから最大 b.length バイトをバイト配列に読み込みます。このメソッドはなんらかの入力が可能になるまでブロックします。

パラメータ:

b - データが読み込まれるバッファ

戻り値:

バッファに読み込まれた全バイト数。ファイルの終わりに達してそれ以上データがない場合は -1

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス InputStream 内の read

read

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

入力ストリームから最大 len バイトをバイト配列に読み込みます。このメソッドはなんらかの入力が可能になるまでブロックします。

パラメータ:

b - データが読み込まれるバッファ

off - データの開始オフセット

len - 読み込む最大バイト数

戻り値:

バッファに読み込まれた全バイト数。ファイルの終わりに達してそれ以上データがない場合は -1

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス InputStream 内の read

skip

public long skip(long n)
          throws IOException

入力ストリームからのデータを n バイトだけスキップして廃棄します。さまざまな理由から、skip メソッドは、指定されたよりも少ないバイト (0 の場合もある) しかスキップしないことがあります。実際にスキップしたバイト数を返します。

パラメータ:

n - スキップするバイト数

戻り値:

実際にスキップされたバイト数

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス InputStream 内の skip

available

public int available()
              throws IOException

ブロックせずにファイル入力ストリームから読み込むことができるバイト数を返します。

戻り値:

ブロックせずにファイル入力ストリームから読み込むことができるバイト数

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス InputStream 内の available

close

public void close()
           throws IOException

ファイル入力ストリームを閉じ、このストリームに関連するシステムリソースを解放します。

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス InputStream 内の close

getFD

public final FileDescriptor getFD()
                           throws IOException

この FileInputStream に使用されているファイルシステムの実際のファイルへの接続を表す FileDescriptor オブジェクトを返します。

戻り値:

このファイルストリームに関連付けられたファイル記述子オブジェクト

例外:

IOException - 入出力エラーが発生した場合

関連項目:

FileDescriptor

finalize

protected void finalize()
                 throws IOException

ファイル入力ストリームへの参照が存在しなくなったときに、このストリームの close メソッドが確実に呼び出されるようにします。

例外:

IOException - 入出力エラーが発生した場合

オーバーライド:

クラス Object 内の finalize

関連項目:

close()