java.io
クラス FileInputStream

java.lang.Object
  java.io.InputStream
      java.io.FileInputStream

public class FileInputStream
extends InputStream

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

FileInputStream は、イメージデータなどの raw バイトのストリームを読み込むときに使用します。文字のストリームを読み込むときは、FileReader を使用してください。

導入されたバージョン:

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 を作成します。

セキュリティーマネージャーが存在する場合は、ファイル記述子を読み込んでもよいかどうかを確認するために、ファイル記述子 fdObj を引数として checkRead メソッドが呼び出されます。ファイル記述子への読み込みアクセスが拒否されると、SecurityException がスローされます。

fdObj が null の場合は、NullPointerException がスローされます。

パラメータ:

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

例外:

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

関連項目:

SecurityManager.checkRead(java.io.FileDescriptor)

メソッドの詳細

read

public int read()
         throws IOException

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

定義:

クラス InputStream 内の read

戻り値:

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

例外:

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

read

public int read(byte[] b)
         throws IOException

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

オーバーライド:

クラス InputStream 内の read

パラメータ:

b - データの読み込み先のバッファー

戻り値:

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

例外:

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

関連項目:

InputStream.read(byte[], int, int)

read

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

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

オーバーライド:

クラス InputStream 内の read

パラメータ:

b - データの読み込み先のバッファー

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

len - 読み込まれる最大バイト数

戻り値:

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

例外:

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

関連項目:

InputStream.read()

skip

public long skip(long n)
          throws IOException

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

オーバーライド:

クラス InputStream 内の skip

パラメータ:

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

戻り値:

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

例外:

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

available

public int available()
              throws IOException

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

オーバーライド:

クラス InputStream 内の available

戻り値:

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

例外:

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

close

public void close()
           throws IOException

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

このストリームにチャネルが関連付けられている場合は、そのチャネルも閉じます。

オーバーライド:

クラス InputStream 内の close

例外:

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

getFD

public final FileDescriptor getFD()
                           throws IOException

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

戻り値:

このストリームに関連するファイル記述子オブジェクト

例外:

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

関連項目:

FileDescriptor

finalize

protected void finalize()
                 throws IOException

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

オーバーライド:

クラス Object 内の finalize

例外:

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

関連項目:

close()