java.io

クラス FileOutputStream

java.lang.Object

java.io.OutputStream

java.io.FileOutputStream

すべての実装されたインタフェース:

Closeable、Flushable、AutoCloseable

public class FileOutputStream
extends OutputStream

ファイル出力ストリームは、File または FileDescriptor にデータを書き込むための出力ストリームです。ファイルが使用可能であるかどうか、またはファイルを作成できるかどうかは、ベースとなるプラットフォームによって決まります。特に、一部のプラットフォームでは、1 つのファイルは同時に 1 つの FileOutputStream (またはその他のファイル書き込みオブジェクト) だけによって書き込みのために開くことができます。このような場合、該当のファイルがすでに開かれていると、このクラスのコンストラクタは失敗します。

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

導入されたバージョン:

JDK1.0

関連項目:

File、FileDescriptor、FileInputStream、Files.newOutputStream(java.nio.file.Path, java.nio.file.OpenOption...)

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileOutputStream(File file) 指定された File オブジェクトによって表されるファイルに書き込むためのファイル出力ストリームを作成します。
FileOutputStream(File file, boolean append) 指定された File オブジェクトによって表されるファイルに書き込むためのファイル出力ストリームを作成します。
FileOutputStream(FileDescriptor fdObj) ファイルシステムの実際のファイルへの既存の接続を表す、指定されたファイル記述子に書き込むためのファイル出力ストリームを作成します。
FileOutputStream(String name) 指定された名前のファイルに書き込むためのファイル出力ストリームを作成します。
FileOutputStream(String name, boolean append) 指定された名前のファイルに書き込むためのファイル出力ストリームを作成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
void	close() ファイル出力ストリームを閉じ、このストリームに関連するすべてのシステムリソースを解放します。
protected void	finalize() ファイルへの接続をクリーンアップし、このストリームへの参照がなくなったときにこのファイル出力ストリームの close メソッドが呼び出されるようにします。
FileChannel	getChannel() このファイル出力ストリームに関連付けられている一意の FileChannel オブジェクトを返します。
FileDescriptor	getFD() ストリームに関連したファイル記述子を返します。
void	write(byte[] b) 指定されたバイト配列の b.length バイトをこのファイル出力ストリームに書き込みます。
void	write(byte[] b, int off, int len) 指定されたバイト配列のオフセット位置 off から始まる len バイトをこのファイル出力ストリームに書き込みます。
void	write(int b) 指定されたバイトをこのファイル出力ストリームに書き込みます。

クラス java.io.OutputStream から継承されたメソッド

flush

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

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

コンストラクタの詳細

FileOutputStream

public FileOutputStream(String name)
                 throws FileNotFoundException

指定された名前のファイルに書き込むためのファイル出力ストリームを作成します。このファイル接続を表すために、新しい FileDescriptor オブジェクトが作成されます。

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

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

パラメータ:

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

例外:

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

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

関連項目:

SecurityManager.checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(String name,
                boolean append)
                 throws FileNotFoundException

指定された名前のファイルに書き込むためのファイル出力ストリームを作成します。2 番目の引数が true の場合、バイトはファイルの先頭ではなく最後に書き込まれます。このファイル接続を表すために、新しい FileDescriptor オブジェクトが作成されます。

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

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

パラメータ:

name - システム依存のファイル名

append - true の場合、バイトはファイルの先頭ではなく最後に書き込まれる

例外:

FileNotFoundException - ファイルが存在するが通常ファイルではなくディレクトリである場合、存在せず作成もできない場合、またはなんらかの理由で開くことができない場合。

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

導入されたバージョン:

JDK1.1

関連項目:

SecurityManager.checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(File file)
                 throws FileNotFoundException

指定された File オブジェクトによって表されるファイルに書き込むためのファイル出力ストリームを作成します。このファイル接続を表すために、新しい FileDescriptor オブジェクトが作成されます。

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

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

パラメータ:

file - 書き込み用に開かれるファイル。

例外:

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

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

関連項目:

File.getPath()、SecurityException, SecurityManager.checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(File file,
                boolean append)
                 throws FileNotFoundException

指定された File オブジェクトによって表されるファイルに書き込むためのファイル出力ストリームを作成します。2 番目の引数が true の場合、バイトはファイルの先頭ではなく最後に書き込まれます。このファイル接続を表すために、新しい FileDescriptor オブジェクトが作成されます。

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

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

パラメータ:

file - 書き込み用に開かれるファイル。

append - true の場合、バイトはファイルの先頭ではなく最後に書き込まれる

例外:

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

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

導入されたバージョン:

1.4

関連項目:

File.getPath()、SecurityException, SecurityManager.checkWrite(java.lang.String)

FileOutputStream

public FileOutputStream(FileDescriptor fdObj)

ファイルシステムの実際のファイルへの既存の接続を表す、指定されたファイル記述子に書き込むためのファイル出力ストリームを作成します。

まず、セキュリティーマネージャーが存在する場合、checkWrite メソッドが、ファイル記述子 fdObj 引数を引数として呼び出されます。

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

fdObj が invalid の場合、このコンストラクタは例外をスローしません。ただし、結果となるストリームに対してそのストリームへの入出力を試みるメソッドが呼び出された場合は、IOException がスローされます。

パラメータ:

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

例外:

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

関連項目:

SecurityManager.checkWrite(java.io.FileDescriptor)

メソッドの詳細

write

public void write(int b)
           throws IOException

指定されたバイトをこのファイル出力ストリームに書き込みます。OutputStream の write メソッドを実装します。

定義:

write、クラス: OutputStream

パラメータ:

b - 書き込まれるバイト。

例外:

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

write

public void write(byte[] b)
           throws IOException

指定されたバイト配列の b.length バイトをこのファイル出力ストリームに書き込みます。

オーバーライド:

write、クラス: OutputStream

パラメータ:

b - データ。

例外:

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

関連項目:

OutputStream.write(byte[], int, int)

write

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

指定されたバイト配列のオフセット位置 off から始まる len バイトをこのファイル出力ストリームに書き込みます。

オーバーライド:

write、クラス: OutputStream

パラメータ:

b - データ。

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

len - 書き込むバイト数。

例外:

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

close

public void close()
           throws IOException

ファイル出力ストリームを閉じ、このストリームに関連するすべてのシステムリソースを解放します。以降は、このファイル出力ストリームをバイトの書き込みに使用することはできません。

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

定義:

close、インタフェース: Closeable

定義:

close、インタフェース: AutoCloseable

オーバーライド:

close、クラス: OutputStream

例外:

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

getFD

public final FileDescriptor getFD()
                           throws IOException

ストリームに関連したファイル記述子を返します。

戻り値:

この FileOutputStream オブジェクトによって使用されているファイルシステムのファイルへの接続を表す FileDescriptor オブジェクト。

例外:

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

関連項目:

FileDescriptor

getChannel

public FileChannel getChannel()

このファイル出力ストリームに関連付けられている一意の FileChannel オブジェクトを返します。

返されたチャネルの position の初期値は、それまでにファイルに書き込まれたバイト数に設定されます。ただし、このストリームが追加モードの場合は、ファイルの大きさに設定されます。このストリームにバイトを書き込むたびにチャネルの位置が増分されます。チャネルの位置が明示的に変更された場合、または書き込みよって変更された場合は、このストリームのファイル位置が変更されます。

戻り値:

このファイル出力ストリームに関連付けられているファイルチャネル

導入されたバージョン:

1.4

finalize

protected void finalize()
                 throws IOException

ファイルへの接続をクリーンアップし、このストリームへの参照がなくなったときにこのファイル出力ストリームの close メソッドが呼び出されるようにします。

オーバーライド:

finalize、クラス: Object

例外:

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

関連項目:

FileInputStream.close()