java.io
クラス PrintStream

java.lang.Object
  java.io.OutputStream
      java.io.FilterOutputStream
          java.io.PrintStream

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

Closeable, Flushable, Appendable

直系の既知のサブクラス:

LogStream

public class PrintStream
extends FilterOutputStream
implements Appendable, Closeable

PrintStream は、ほかの出力ストリームに機能を追加します。具体的には、さまざまなデータ値の表現を簡易的に出力する機能を追加します。同様に、ほかの 2 つの機能も提供されています。PrintStream はほかの出力ストリームとは違って、 IOException をスローすることはありません。例外的な状況では、単に内部フラグが設定されるだけです。このフラグの状態は、checkError メソッドで調べることができます。必要に応じて、PrintStream を自動的にフラッシュするように作成できます。つまり、バイト配列が書き込まれたか、println メソッドの 1 つが呼び出されたか、または改行文字またはバイト ('\n') が書き込まれたあとに、flush メソッドが自動的に呼び出されます。

PrintStream が出力したすべての文字は、プラットフォームのデフォルトの文字エンコーディングを使ってバイトに変換されます。PrintWriter クラスは、バイトではなく文字を書き込むことが必要な状況で使用されます。

導入されたバージョン:

JDK1.0

フィールドの概要

クラス java.io.FilterOutputStream から継承されたフィールド

out

コンストラクタの概要

PrintStream(File file)
行の自動フラッシュは行わずに、指定のファイルで新しい出力ストリームを作成します。

PrintStream(File file, String csn)
行の自動フラッシュは行わずに、指定のファイルと文字セットで 新しい出力ストリームを作成します。

PrintStream(OutputStream out)
新しい PrintStream を作成します。

PrintStream(OutputStream out, boolean autoFlush)
新しい PrintStream を作成します。

PrintStream(OutputStream out, boolean autoFlush, String encoding)
新しい PrintStream を作成します。

PrintStream(String fileName)
行の自動フラッシュは行わずに、指定の名前で新しい出力ストリームを作成します。

PrintStream(String fileName, String csn)
行の自動フラッシュは行わずに、指定の名前と文字セットで 新しい出力ストリームを作成します。

メソッドの概要

PrintStream	append(char c) この出力ストリームに指定された文字を追加します。
PrintStream	append(CharSequence csq) この出力ストリームに指定された文字シーケンスを追加します。
PrintStream	append(CharSequence csq, int start, int end) 指定された文字シーケンスのサブシーケンスをこの出力ストリームに追加します。
boolean	checkError() ストリームをフラッシュし、そのエラー状況を確認します。
protected void	clearError() このストリームの内部エラー状態を解除します。
void	close() ストリームを閉じます。
void	flush() ストリームをフラッシュします。
PrintStream	format(Locale l, String format, Object... args) 指定された書式文字列および引数を使用して、書式付き文字列をこの出力ストリームの宛先に書き込みます。
PrintStream	format(String format, Object... args) 指定された書式文字列および引数を使用して、書式付き文字列をこの出力ストリームの宛先に書き込みます。
void	print(boolean b) boolean 型の値を出力します。
void	print(char c) 文字を出力します。
void	print(char[] s) 文字の配列を出力します。
void	print(double d) 倍精度の浮動小数点数を出力します。
void	print(float f) 浮動小数点数を出力します。
void	print(int i) 整数を出力します。
void	print(long l) long 整数を出力します。
void	print(Object obj) オブジェクトを出力します。
void	print(String s) 文字列を出力します。
PrintStream	printf(Locale l, String format, Object... args) 書式付き文字列を、指定された書式文字列と引数を使用し、この出力ストリームに書き込む便利な方法です。
PrintStream	printf(String format, Object... args) 書式付き文字列を、指定された書式文字列と引数を使用し、この出力ストリームに書き込む便利な方法です。
void	println() 行の区切り文字列を書き込むことで、現在の行を終了させます。
void	println(boolean x) boolean 値を出力して、行を終了します。
void	println(char x) 文字を出力して、行を終了します。
void	println(char[] x) 文字の配列を出力して、行を終了します。
void	println(double x) double を出力して、行を終了します。
void	println(float x) float を出力して、行を終了します。
void	println(int x) 整数を出力して、行を終了します。
void	println(long x) long を出力して、行を終了します。
void	println(Object x) Object を出力して、行を終了します。
void	println(String x) String を出力して、行を終了します。
protected void	setError() ストリームのエラー状態を true に設定します。
void	write(byte[] buf, int off, int len) オフセット位置 off から始まる指定されたバイト配列から、このストリームに len バイトを書き込みます。
void	write(int b) 指定されたバイトを、このストリームに書き込みます。

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

write

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

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

コンストラクタの詳細

PrintStream

public PrintStream(OutputStream out)

新しい PrintStream を作成します。このストリームは、自動的にフラッシュすることはありません。

パラメータ:

out - 値とオブジェクトが出力される出力ストリーム

関連項目:

PrintWriter.PrintWriter(java.io.OutputStream)

PrintStream

public PrintStream(OutputStream out,
                   boolean autoFlush)

新しい PrintStream を作成します。

パラメータ:

out - 値とオブジェクトが出力される出力ストリーム

autoFlush - boolean 値。true の場合、バイト配列が書き込まれたとき、println メソッドの 1 つが呼び出されたとき、または改行文字またはバイト ('\n') が書き込まれたときに、出力バッファーがフラッシュされる

関連項目:

PrintWriter.PrintWriter(java.io.OutputStream, boolean)

PrintStream

public PrintStream(OutputStream out,
                   boolean autoFlush,
                   String encoding)
            throws UnsupportedEncodingException

新しい PrintStream を作成します。

パラメータ:

out - 値とオブジェクトが出力される出力ストリーム

autoFlush - boolean 値。true の場合、バイト配列が書き込まれたとき、println メソッドの 1 つが呼び出されたとき、または改行文字またはバイト ('\n') が書き込まれたときに、出力バッファーがフラッシュされる

encoding - サポートされる「文字エンコーディング」の名前

例外:

UnsupportedEncodingException - 指定された文字エンコーディングがサポートされていない場合

導入されたバージョン:

1.4

PrintStream

public PrintStream(String fileName)
            throws FileNotFoundException

行の自動フラッシュは行わずに、指定の名前で新しい出力ストリームを作成します。この簡易コンストラクタは、必要となる中間の OutputStreamWriter を作成します。これは、この Java 仮想マシンインスタンスのデフォルト文字セットを使用して、文字をエンコードします。

パラメータ:

fileName - この出力ストリームの宛先として使用するファイルの名前。ファイルが存在する場合、サイズ 0 に切り詰められる。ファイルがなければ新しいファイルが作成される。出力はファイルに書き込まれ、バッファーに格納される

例外:

FileNotFoundException - 指定されたファイルオブジェクトが既存のファイルを示さない場合、書き込み可能な通常のファイルおよび新規の通常ファイルがその名前で作成できない場合、またはファイルのオープンまたは作成中にその他のエラーが発生した場合

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

導入されたバージョン:

1.5

PrintStream

public PrintStream(String fileName,
                   String csn)
            throws FileNotFoundException,
                   UnsupportedEncodingException

行の自動フラッシュは行わずに、指定の名前と文字セットで 新しい出力ストリームを作成します。この簡易コンストラクタは、必要となる中間の OutputStreamWriter を作成します。これは、提供された文字セットを使用して文字をエンコードします。

パラメータ:

fileName - この出力ストリームの宛先として使用するファイルの名前。ファイルが存在する場合、サイズ 0 に切り詰められる。ファイルがなければ新しいファイルが作成される。出力はファイルに書き込まれ、バッファーに格納される

csn - サポートする charset の名前

例外:

FileNotFoundException - 指定されたファイルオブジェクトが既存のファイルを示さない場合、書き込み可能な通常のファイルおよび新規の通常ファイルがその名前で作成できない場合、またはファイルのオープンまたは作成中にその他のエラーが発生した場合

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

UnsupportedEncodingException - 指定された文字セットがサポートされていない場合

導入されたバージョン:

1.5

PrintStream

public PrintStream(File file)
            throws FileNotFoundException

行の自動フラッシュは行わずに、指定のファイルで新しい出力ストリームを作成します。この簡易コンストラクタは、必要となる中間の OutputStreamWriter を作成します。これは、この Java 仮想マシンインスタンスのデフォルト文字セットを使用して、文字をエンコードします。

パラメータ:

file - この出力ストリームの宛先として使用するファイル。ファイルが存在する場合、サイズ 0 に切り詰められる。ファイルがなければ新しいファイルが作成される。出力はファイルに書き込まれ、バッファーに格納される

例外:

FileNotFoundException - 指定されたファイルオブジェクトが既存のファイルを示さない場合、書き込み可能な通常のファイルおよび新規の通常ファイルがその名前で作成できない場合、またはファイルのオープンまたは作成中にその他のエラーが発生した場合

SecurityException - セキュリティーマネージャーが存在し、セキュリティーマネージャーの checkWrite(file.getPath()) メソッドがファイルへの書き込みアクセスを許可しない場合

導入されたバージョン:

1.5

PrintStream

public PrintStream(File file,
                   String csn)
            throws FileNotFoundException,
                   UnsupportedEncodingException

行の自動フラッシュは行わずに、指定のファイルと文字セットで 新しい出力ストリームを作成します。この簡易コンストラクタは、必要となる中間の OutputStreamWriter を作成します。これは、提供された文字セットを使用して文字をエンコードします。

パラメータ:

file - この出力ストリームの宛先として使用するファイル。ファイルが存在する場合、サイズ 0 に切り詰められる。ファイルがなければ新しいファイルが作成される。出力はファイルに書き込まれ、バッファーに格納される

csn - サポートする charset の名前

例外:

FileNotFoundException - 指定されたファイルオブジェクトが既存のファイルを示さない場合、書き込み可能な通常のファイルおよび新規の通常ファイルがその名前で作成できない場合、またはファイルのオープンまたは作成中にその他のエラーが発生した場合

SecurityException - セキュリティーマネージャーが存在し、セキュリティーマネージャーの checkWrite(file.getPath()) ソッドがファイルへの書き込みアクセスを許可しない場合

UnsupportedEncodingException - 指定された文字セットがサポートされていない場合

導入されたバージョン:

1.5

メソッドの詳細

flush

public void flush()

ストリームをフラッシュします。バッファーされた出力バイトを基本となる出力ストリームに書き込み、このストリームをフラッシュします。

定義:

インタフェース Flushable 内の flush

オーバーライド:

クラス FilterOutputStream 内の flush

関連項目:

OutputStream.flush()

close

public void close()

ストリームを閉じます。ストリームをフラッシュし、基本となる出力ストリームを閉じます。

定義:

インタフェース Closeable 内の close

オーバーライド:

クラス FilterOutputStream 内の close

関連項目:

OutputStream.close()

checkError

public boolean checkError()

ストリームをフラッシュし、そのエラー状況を確認します。基本となる出力ストリームが InterruptedIOException ではなく IOException をスローした場合、および setError メソッドが呼び出された場合に、内部エラー状態は true に設定されます。基本となる出力ストリームのオペレーションが InterruptedIOException をスローすると、PrintStream が次の操作またはそれに相当する操作によって例外を変換して割り込みに戻します。

     Thread.currentThread().interrupt();
 

または同等のもの

戻り値:

このストリームが InterruptedIOException ではなく IOException を検出した場合、または setError メソッドが呼び出された場合は true

setError

protected void setError()

ストリームのエラー状態を true に設定します。

このメソッドを使用すると、clearError() が呼び出されるまで、checkError() が引き続き呼び出されて true が返されます。

導入されたバージョン:

JDK1.1

clearError

protected void clearError()

このストリームの内部エラー状態を解除します。

このメソッドを使用すると、別の書き込み処理が失敗して、setError() が呼び出されるまで、checkError() が引き続き呼び出されて false が返されます。

導入されたバージョン:

1.6

write

public void write(int b)

指定されたバイトを、このストリームに書き込みます。バイトが復帰改行で、自動フラッシュが有効な場合は、flush メソッドが呼び出されます。

バイトは、指定されたまま書き込まれることに注意してください。プラットフォームのデフォルトの文字エンコーディングに従って変換された文字を書き込むには、print(char) または println(char) メソッドを使用します。

オーバーライド:

クラス FilterOutputStream 内の write

パラメータ:

b - 書き込まれるバイト

関連項目:

print(char), println(char)

write

public void write(byte[] buf,
                  int off,
                  int len)

オフセット位置 off から始まる指定されたバイト配列から、このストリームに len バイトを書き込みます。自動フラッシュが有効な場合は、flush メソッドが呼び出されます。

バイトは、指定されたまま書き込まれます。プラットフォームのデフォルトの文字エンコーディングに従って変換された文字列を書き込むには、print(char) メッソドまたは println(char) メソッドを使用します。

オーバーライド:

クラス FilterOutputStream 内の write

パラメータ:

buf - バイト配列

off - バイトの取り込み開始オフセット

len - 書き込まれるバイト数

関連項目:

FilterOutputStream.write(int)

print

public void print(boolean b)

boolean 型の値を出力します。String.valueOf(boolean) により作成された文字列は、プラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

b - 出力される boolean 値

print

public void print(char c)

文字を出力します。文字はプラットフォームのデフォルトの文字エンコーディングに従って 1 つ以上のバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

c - 出力される char 値

print

public void print(int i)

整数を出力します。String.valueOf(int) により作成された文字列は、プラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

i - 出力される int 値

関連項目:

Integer.toString(int)

print

public void print(long l)

long 整数を出力します。String.valueOf(long) により作成された文字列は、プラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

l - 出力される long 値

関連項目:

Long.toString(long)

print

public void print(float f)

浮動小数点数を出力します。String.valueOf(float) により作成された文字列は、プラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

f - 出力される float 値

関連項目:

Float.toString(float)

print

public void print(double d)

倍精度の浮動小数点数を出力します。String.valueOf(double) により作成された文字列は、プラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

d - 出力される double 値

関連項目:

Double.toString(double)

print

public void print(char[] s)

文字の配列を出力します。文字はプラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

s - 出力される char の配列

例外:

NullPointerException - s が null の場合

print

public void print(String s)

文字列を出力します。引数が null の場合は、文字列「null」が出力されます。そうでない場合、文字列の文字はプラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

s - 出力される String 値

print

public void print(Object obj)

オブジェクトを出力します。String.valueOf(Object) メソッドにより作成された文字列は、プラットフォームのデフォルトの文字エンコーディングに従ってバイトに変換され、これらのバイトは write(int) メソッドとまったく同じ方法で書き込まれます。

パラメータ:

obj - 出力される Object 値

関連項目:

Object.toString()

println

public void println()

行の区切り文字列を書き込むことで、現在の行を終了させます。行の区切り文字列は、システムプロパティー line.separator で定義され、必ずしも単一の改行文字 ('\n') であるとは限りません。

println

public void println(boolean x)

boolean 値を出力して、行を終了します。このメソッドは、print(boolean) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される boolean 値

println

public void println(char x)

文字を出力して、行を終了します。このメソッドは、print(char) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される char 値

println

public void println(int x)

整数を出力して、行を終了します。このメソッドは、print(int) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される int 値

println

public void println(long x)

long を出力して、行を終了します。このメソッドは、print(long) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される long 値

println

public void println(float x)

float を出力して、行を終了します。このメソッドは、print(float) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される float 値

println

public void println(double x)

double を出力して、行を終了します。このメソッドは、print(double) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される double 値

println

public void println(char[] x)

文字の配列を出力して、行を終了します。このメソッドは、print(char[]) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される char の配列

println

public void println(String x)

String を出力して、行を終了します。このメソッドは、print(String) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される String 値

println

public void println(Object x)

Object を出力して、行を終了します。このメソッドは、最初に String.valueOf(x) を呼び出して、出力されたオブジェクトの文字列値を取得します。次に、print(String) を呼び出してから println() を呼び出すのと同じように動作します。

パラメータ:

x - 出力される Object 値

printf

public PrintStream printf(String format,
                          Object... args)

書式付き文字列を、指定された書式文字列と引数を使用し、この出力ストリームに書き込む便利な方法です。

このメソッドを out.printf(format, args) の形式で呼び出すと、次の呼び出しと同じ結果になります。

     out.format(format, args) 

パラメータ:

format - 「書式文字列の構文」で説明した書式文字列

args - 書式文字列の書式指示子により参照される引数。書式指示子よりも引数が多い場合、余分な引数は無視される。引数の数は変動し、ゼロの場合もある。引数の最大数は、Java 仮想マシン仕様で定義されている Java 配列の最大次元により制限される。引数が null の場合、動作は変換に応じて異なる

戻り値:

この出力ストリーム

例外:

IllegalFormatException - 書式文字列が、不正な構文、所定の引数と互換性がない書式指示子、書式文字列に与えられた不適切な引数、あるいはほかの不正な条件を含む場合。考えられるすべての書式エラーの仕様については、フォーマッタクラス仕様の「詳細」セクションを参照

NullPointerException - format が null の場合

導入されたバージョン:

1.5

printf

public PrintStream printf(Locale l,
                          String format,
                          Object... args)

書式付き文字列を、指定された書式文字列と引数を使用し、この出力ストリームに書き込む便利な方法です。

このメソッドを out.printf(l, format, args) の形式で呼び出すと、次の呼び出しと同じ結果になります。

     out.format(l, format, args) 

パラメータ:

l - 書式設定時に適用する locale。l が null の場合、ローカリゼーションは適用されない。

format - 「書式文字列の構文」で説明した書式文字列

args - 書式文字列の書式指示子により参照される引数。書式指示子よりも引数が多い場合、余分な引数は無視される。引数の数は変動し、ゼロの場合もある。引数の最大数は、Java 仮想マシン仕様で定義されている Java 配列の最大次元により制限される。引数が null の場合、動作は変換に応じて異なる

戻り値:

この出力ストリーム

例外:

IllegalFormatException - 書式文字列が、不正な構文、所定の引数と互換性がない書式指示子、書式文字列に与えられた不適切な引数、あるいはほかの不正な条件を含む場合。考えられるすべての書式エラーの仕様については、フォーマッタクラス仕様の「詳細」セクションを参照

NullPointerException - format が null の場合

導入されたバージョン:

1.5

format

public PrintStream format(String format,
                          Object... args)

指定された書式文字列および引数を使用して、書式付き文字列をこの出力ストリームの宛先に書き込みます。

このオブジェクトに対して別の書式設定メソッドが先に呼び出されていたかどうかにかかわらず、Locale.getDefault() により返されるロケールが常に使用されます。

パラメータ:

format - 「書式文字列の構文」で説明した書式文字列

args - 書式文字列の書式指示子により参照される引数。書式指示子よりも引数が多い場合、余分な引数は無視される。引数の数は変動し、ゼロの場合もある。引数の最大数は、Java 仮想マシン仕様で定義されている Java 配列の最大次元により制限される。引数が null の場合、動作は変換に応じて異なる

戻り値:

この出力ストリーム

例外:

IllegalFormatException - 書式文字列が、不正な構文、所定の引数と互換性がない書式指示子、書式文字列に与えられた不適切な引数、あるいはほかの不正な条件を含む場合。考えられるすべての書式エラーの仕様については、フォーマッタクラス仕様の「詳細」セクションを参照

NullPointerException - format が null の場合

導入されたバージョン:

1.5

format

public PrintStream format(Locale l,
                          String format,
                          Object... args)

指定された書式文字列および引数を使用して、書式付き文字列をこの出力ストリームの宛先に書き込みます。

パラメータ:

l - 書式設定時に適用する locale。l が null の場合、ローカリゼーションは適用されない。

format - 「書式文字列の構文」で説明した書式文字列

args - 書式文字列の書式指示子により参照される引数。書式指示子よりも引数が多い場合、余分な引数は無視される。引数の数は変動し、ゼロの場合もある。引数の最大数は、Java 仮想マシン仕様で定義されている Java 配列の最大次元により制限される。引数が null の場合、動作は変換に応じて異なる

戻り値:

この出力ストリーム

例外:

IllegalFormatException - 書式文字列が、不正な構文、所定の引数と互換性がない書式指示子、書式文字列に与えられた不適切な引数、あるいはほかの不正な条件を含む場合。考えられるすべての書式エラーの仕様については、フォーマッタクラス仕様の「詳細」セクションを参照

NullPointerException - format が null の場合

導入されたバージョン:

1.5

append

public PrintStream append(CharSequence csq)

この出力ストリームに指定された文字シーケンスを追加します。

このメソッドを out.append(csq) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     out.print(csq.toString()) 

文字シーケンス csq に対する toString の指定に応じて、シーケンス全体が追加されないこともあります。たとえば、文字バッファーの toString 呼び出すと、内容がバッファーの位置とリミットに依存するサブシーケンスが返されます。

定義:

インタフェース Appendable 内の append

パラメータ:

csq - 追加される文字シーケンス。csq が null の場合は、この出力ストリームに「null」という 4 文字が追加される

戻り値:

この出力ストリーム

導入されたバージョン:

1.5

append

public PrintStream append(CharSequence csq,
                          int start,
                          int end)

指定された文字シーケンスのサブシーケンスをこの出力ストリームに追加します。

csq が null ではないときに、このメソッドを out.append(csq, start, end) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     out.print(csq.subSequence(start, end).toString()) 

定義:

インタフェース Appendable 内の append

パラメータ:

csq - サブシーケンスの追加元の文字シーケンス。csq が null であれば、csq に「null」という 4 文字が含まれているかのように追加される

start - サブシーケンスの最初の文字のインデックス

end - サブシーケンスの最後の文字のあとに続く文字のインデックス

戻り値:

この出力ストリーム

例外:

IndexOutOfBoundsException - start または end が負の値の場合、start が end より大きい場合、または end が csq.length() より大きい場合

導入されたバージョン:

1.5

append

public PrintStream append(char c)

この出力ストリームに指定された文字を追加します。

このメソッドを out.append(c) の形式で呼び出した場合、次の呼び出しと同じ結果が得られます。

     out.print(c) 

定義:

インタフェース Appendable 内の append

パラメータ:

c - 追加される 16 ビット文字

戻り値:

この出力ストリーム

導入されたバージョン:

1.5