Java : PrintWriter - API使用例
PrintWriter (Java SE 18 & JDK 18) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様のおともにどうぞ。
概要
オブジェクトの書式付き表現をテキスト出力ストリームに出力します。 このクラスは、PrintStreamで見つかったすべてのprintメソッドを実装します。
PrintWriterクラスは
- boolean, int, floatといった基本データ型
- 文字列
- オブジェクト
を便利に書き出すメソッドを持ちます。
final var sw = new StringWriter();
try (final var writer = new PrintWriter(sw)) {
writer.println("abc");
writer.printf("num = %d", 1234);
}
System.out.println(sw);
// 結果
// ↓
//abc
//num = 1234
また、PrintWriterクラスは、一部のコンストラクタを除き、IOExceptionを発生させることはありません。
代わりに checkErrorメソッドでエラーを確認します。
フィールド
protected Writer out
このPrintWriterのベースとなる文字出力ストリームです。
protected です。
独自にサブクラスを作ることは少ないと思いますので、コード例は割愛します。
Writerで宣言されたフィールド
lock
「Java API 使用例 : Writer」をご参照ください。
コンストラクタ
PrintWriter (File file)
行の自動フラッシュは行わずに、指定されたファイルで新しいPrintWriterを作成します。
final var file = Path.of("R:", "java-work", "sample.txt");
try (final var writer = new PrintWriter(file.toFile())) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(Files.readString(file));
// 結果
// ↓
//abc
//1234
//○△×
PrintWriter (File file, String csn)
行の自動フラッシュは行わずに、指定されたファイルと文字セットで新しいPrintWriterを作成します。
System.out.println("default charset : " + Charset.defaultCharset());
final var file = Path.of("R:", "java-work", "sample.txt");
final var csn = "Shift_JIS";
System.out.println("-- write --");
try (final var writer = new PrintWriter(file.toFile(), csn)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(Files.readString(file, Charset.forName(csn)));
// 結果
// ↓
//default charset : UTF-8
//-- write --
//abc
//1234
//○△×
PrintWriter (File file, Charset charset)
行の自動フラッシュは行わずに、指定されたファイルと文字セットで新しいPrintWriterを作成します。
System.out.println("default charset : " + Charset.defaultCharset());
final var file = Path.of("R:", "java-work", "sample.txt");
final var charset = Charset.forName("Shift_JIS");
System.out.println("-- write --");
try (final var writer = new PrintWriter(file.toFile(), charset)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(Files.readString(file, charset));
// 結果
// ↓
//default charset : UTF-8
//-- write --
//abc
//1234
//○△×
PrintWriter (OutputStream out)
行の自動フラッシュは行わずに、既存のOutputStreamから新しいPrintWriterを作成します。
final var out = new ByteArrayOutputStream();
try (final var writer = new PrintWriter(out)) {
writer.println("abc");
writer.println(1234);
}
System.out.println(out);
// 結果
// ↓
//abc
//1234
PrintWriter (OutputStream out, boolean autoFlush)
既存のOutputStreamから新しいPrintWriterを作成します。
// autoFlush = false では、println や printf, format メソッドを呼び出しても
// バッファはフラッシュされません。
final var out = new ByteArrayOutputStream();
try (final var writer = new PrintWriter(out, false)) {
writer.print("abc");
System.out.println(out.toString().isEmpty());
// 結果
// ↓
//true
writer.println("XYZ");
System.out.println(out.toString().isEmpty());
// 結果
// ↓
//true
writer.printf("num = %d", 1234);
System.out.println(out.toString().isEmpty());
// 結果
// ↓
//true
}
System.out.println(out);
// 結果
// ↓
//abcXYZ
//num = 1234
// autoFlush = true では、println や printf, format メソッドを呼び出すと
// バッファはフラッシュされます。
final var out = new ByteArrayOutputStream();
try (final var writer = new PrintWriter(out, true)) {
// print ではバッファはフラッシュされません。
writer.print("abc");
System.out.println(out.toString().isEmpty());
// 結果
// ↓
//true
writer.println("XYZ");
System.out.println(out);
// 結果
// ↓
//abcXYZ
writer.printf("num = %d", 1234);
System.out.println(out);
// 結果
// ↓
//abcXYZ
//num = 1234
}
System.out.println(out);
// 結果
// ↓
//abcXYZ
//num = 1234
PrintWriter (OutputStream out, boolean autoFlush, Charset charset)
既存のOutputStreamから新しいPrintWriterを作成します。
autoFlush については、PrintWriter(OutputStream out, boolean autoFlush) の使用例に記載しました。
そちらもご参照ください。
System.out.println("default charset : " + Charset.defaultCharset());
final var out = new ByteArrayOutputStream();
final var charset = Charset.forName("Shift_JIS");
System.out.println("-- write --");
try (final var writer = new PrintWriter(out, false, charset)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(out.toString(charset));
// 結果
// ↓
//default charset : UTF-8
//-- write --
//abc
//1234
//○△×
PrintWriter (Writer out)
行の自動フラッシュは行わずに、新しいPrintWriterを作成します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(out);
// 結果
// ↓
//abc
//1234
//○△×
PrintWriter (Writer out, boolean autoFlush)
新しいPrintWriterを作成します。
// autoFlush = false では、println や printf, format メソッドを呼び出しても
// バッファはフラッシュされません。
final var sw = new StringWriter();
try (final var out = new BufferedWriter(sw);
final var writer = new PrintWriter(out, false)) {
writer.print("abc");
System.out.println(sw.toString().isEmpty());
// 結果
// ↓
//true
writer.println("XYZ");
System.out.println(sw.toString().isEmpty());
// 結果
// ↓
//true
writer.printf("num = %d", 1234);
System.out.println(sw.toString().isEmpty());
// 結果
// ↓
//true
}
System.out.println(sw);
// 結果
// ↓
//abcXYZ
//num = 1234
// autoFlush = true では、println や printf, format メソッドを呼び出すと
// バッファはフラッシュされます。
final var sw = new StringWriter();
try (final var out = new BufferedWriter(sw);
final var writer = new PrintWriter(out, true)) {
// printではバッファはフラッシュされません。
writer.print("abc");
System.out.println(sw.toString().isEmpty());
// 結果
// ↓
//true
writer.println("XYZ");
System.out.println(sw);
// 結果
// ↓
//abcXYZ
writer.printf("num = %d", 1234);
System.out.println(sw);
// 結果
// ↓
//abcXYZ
//num = 1234
}
System.out.println(sw);
// 結果
// ↓
//abcXYZ
//num = 1234
PrintWriter (String fileName)
行の自動フラッシュは行わずに、指定されたファイル名で新しいPrintWriterを作成します。
final var file = Path.of("R:", "java-work", "sample.txt");
final var fileName = file.toString();
System.out.println("file name : " + fileName);
System.out.println("-- write --");
try (final var writer = new PrintWriter(fileName)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(Files.readString(file));
// 結果
// ↓
//file name : R:\java-work\sample.txt
//-- write --
//abc
//1234
//○△×
PrintWriter (String fileName, String csn)
行の自動フラッシュは行わずに、指定されたファイル名と文字セットで新しいPrintWriterを作成します。
System.out.println("default charset : " + Charset.defaultCharset());
final var file = Path.of("R:", "java-work", "sample.txt");
final var fileName = file.toString();
System.out.println("file name : " + fileName);
final var csn = "Shift_JIS";
System.out.println("-- write --");
try (final var writer = new PrintWriter(fileName, csn)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(Files.readString(file, Charset.forName(csn)));
// 結果
// ↓
//default charset : UTF-8
//file name : R:\java-work\sample.txt
//-- write --
//abc
//1234
//○△×
PrintWriter (String fileName, Charset charset)
行の自動フラッシュは行わずに、指定されたファイル名と文字セットで新しいPrintWriterを作成します。
System.out.println("default charset : " + Charset.defaultCharset());
final var file = Path.of("R:", "java-work", "sample.txt");
final var fileName = file.toString();
System.out.println("file name : " + fileName);
final var charset = Charset.forName("Shift_JIS");
System.out.println("-- write --");
try (final var writer = new PrintWriter(fileName, charset)) {
writer.println("abc");
writer.println(1234);
writer.println("○△×");
}
System.out.print(Files.readString(file, charset));
// 結果
// ↓
//default charset : UTF-8
//file name : R:\java-work\sample.txt
//-- write --
//abc
//1234
//○△×
メソッド
PrintWriter append (char c)
指定された文字をこのライターに追加します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.append('a').append('b').append('c');
}
System.out.println(out); // abc
PrintWriter append (CharSequence csq)
指定された文字シーケンスをこのライターに追加します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.append("abc").append("-").append("XYZ");
}
System.out.println(out); // abc-XYZ
PrintWriter append (CharSequence csq, int start, int end)
指定された文字シーケンスのサブシーケンスをこのライターに追加します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final var csq = "abcd";
writer.append(csq, 0, 1).println();
writer.append(csq, 0, 2).println();
writer.append(csq, 0, 3).println();
writer.append(csq, 0, 4).println();
}
System.out.print(out);
// 結果
// ↓
//a
//ab
//abc
//abcd
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final var csq = "abcd";
writer.append(csq, 0, 4).println();
writer.append(csq, 1, 4).println();
writer.append(csq, 2, 4).println();
writer.append(csq, 3, 4).println();
}
System.out.print(out);
// 結果
// ↓
//abcd
//bcd
//cd
//d
boolean checkError ()
ストリームが閉じられていない場合は、そのストリームをフラッシュし、エラー状態をチェックします。
final var file = Path.of("R:", "java-work", "sample.txt");
try (final var out = Files.newBufferedWriter(file);
final var writer = new PrintWriter(out)) {
writer.println("abc");
System.out.println("error : " + writer.checkError());
// エラーを起こすために意図的にcloseします。
System.out.println("-- close --");
out.close();
writer.println("XYZ");
System.out.println("error : " + writer.checkError());
}
// 結果
// ↓
//error : false
//-- close --
//error : true
protected void clearError ()
このストリームのエラー状態を解除します。
protected です。
独自にサブクラスを作ることは少ないと思いますので、コード例は割愛します。
void close ()
ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。
try-with-resources文を使うことをおすすめします。
final var file = Path.of("R:", "java-work", "sample.txt");
try (final var writer = new PrintWriter(file.toFile())) {
writer.print("abc");
writer.print("XYZ");
}
System.out.println(Files.readString(file)); // abcXYZ
// try-with-resources文を使わない例です。
final var file = Path.of("R:", "java-work", "sample.txt");
final var writer = new PrintWriter(file.toFile());
try {
writer.print("abc");
writer.print("XYZ");
} finally {
writer.close();
}
System.out.println(Files.readString(file)); // abcXYZ
void flush ()
ストリームをフラッシュします。
final var out = new ByteArrayOutputStream();
try (final var writer = new PrintWriter(out, false)) {
writer.print("abc");
System.out.println(out.toString().isEmpty()); // true
writer.print(123);
System.out.println(out.toString().isEmpty()); // true
writer.flush();
System.out.println(out); // abc123
}
PrintWriter format (String format, Object... args)
指定された書式文字列および引数を使用して、書式付き文字列をこのライターに書き込みます。
※printfメソッドと同じです。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.format("text = %s%n", "abc");
writer.format("num = %d%n", 1234);
writer.format("X").format("Y").format("Z");
}
System.out.println(out);
// 結果
// ↓
//text = abc
//num = 1234
//XYZ
PrintWriter format (Locale l, String format, Object... args)
指定された書式文字列および引数を使用して、書式付き文字列をこのライターに書き込みます。
※printfメソッドと同じです。
System.out.println("locale : " + Locale.getDefault());
System.out.println("-- write --");
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final var time = LocalTime.of(14, 30);
writer.format("%tr%n", time);
writer.format(Locale.ENGLISH, "%tr%n", time);
}
System.out.print(out);
// 結果
// ↓
//locale : ja_JP
//-- write --
//02:30:00 午後
//02:30:00 PM
void print (boolean b)
boolean型の値を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(true);
writer.print(" : ");
writer.print(false);
}
System.out.println(out); // true : false
void print (char c)
文字を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print('a');
writer.print(" : ");
writer.print('b');
}
System.out.println(out); // a : b
void print (char[] s)
文字の配列を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(new char[]{'a', 'b', 'c'});
writer.print(" : ");
writer.print(new char[]{'X', 'Y', 'Z'});
}
System.out.println(out); // abc : XYZ
void print (double d)
倍精度の浮動小数点数を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(1.234);
writer.print(" : ");
writer.print(7.89e+10);
}
System.out.println(out); // 1.234 : 7.89E10
void print (float f)
浮動小数点数を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(1.234f);
writer.print(" : ");
writer.print(7.89e+10f);
}
System.out.println(out); // 1.234 : 7.8900003E10
void print (int i)
整数を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(1234);
writer.print(" : ");
writer.print(Integer.MAX_VALUE);
}
System.out.println(out); // 1234 : 2147483647
void print (long l)
long整数を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(1234L);
writer.print(" : ");
writer.print(Long.MAX_VALUE);
}
System.out.println(out); // 1234 : 9223372036854775807
void print (Object obj)
オブジェクトを出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print(Path.of("R:", "java-work"));
writer.print(" : ");
writer.print(LocalTime.of(14, 30));
}
System.out.println(out); // R:\java-work : 14:30
void print (String s)
文字列を出力します。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print("abc");
writer.print(" : ");
writer.print("XYZ");
}
System.out.println(out); // abc : XYZ
PrintWriter printf (String format, Object... args)
指定された書式文字列および引数を使用して、書式付き文字列をこのライターに書き込む簡易メソッドです。
※formatメソッドと同じです。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.printf("text = %s%n", "abc");
writer.printf("num = %d%n", 1234);
writer.printf("X").printf("Y").printf("Z");
}
System.out.println(out);
// 結果
// ↓
//text = abc
//num = 1234
//XYZ
PrintWriter printf (Locale l, String format, Object... args)
指定された書式文字列および引数を使用して、書式付き文字列をこのライターに書き込む簡易メソッドです。
※formatメソッドと同じです。
System.out.println("locale : " + Locale.getDefault());
System.out.println("-- write --");
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final var time = LocalTime.of(14, 30);
writer.printf("%tr%n", time);
writer.printf(Locale.ENGLISH, "%tr%n", time);
}
System.out.print(out);
// 結果
// ↓
//locale : ja_JP
//-- write --
//02:30:00 午後
//02:30:00 PM
void println ()
行の区切り文字列を書き込むことで、現在の行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.print("abc");
writer.println();
writer.print(123);
}
System.out.println(out);
// 結果
// ↓
//abc
//123
void println (boolean x)
boolean値を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(true);
writer.println(false);
}
System.out.print(out);
// 結果
// ↓
//true
//false
void println (char x)
文字を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println('a');
writer.println('b');
}
System.out.print(out);
// 結果
// ↓
//a
//b
void println (char[] x)
文字の配列を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(new char[]{'a', 'b', 'c'});
writer.println(new char[]{'X', 'Y', 'Z'});
}
System.out.print(out);
// 結果
// ↓
//abc
//XYZ
void println (double x)
倍精度浮動小数点数を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(1.234);
writer.println(7.89e+10);
}
System.out.print(out);
// 結果
// ↓
//1.234
//7.89E10
void println (float x)
浮動小数点数を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(1.234f);
writer.println(7.89e+10f);
}
System.out.print(out);
// 結果
// ↓
//1.234
//7.8900003E10
void println (int x)
整数を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(1234);
writer.println(Integer.MAX_VALUE);
}
System.out.print(out);
// 結果
// ↓
//1234
//2147483647
void println (long x)
long型の整数値を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(1234L);
writer.println(Long.MAX_VALUE);
}
System.out.print(out);
// 結果
// ↓
//1234
//9223372036854775807
void println (Object x)
Objectを出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println(Path.of("R:", "java-work"));
writer.println(LocalTime.of(14, 30));
}
System.out.print(out);
// 結果
// ↓
//R:\java-work
//14:30
void println (String x)
文字列を出力し、行を終了させます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.println("abc");
writer.println("XYZ");
}
System.out.print(out);
// 結果
// ↓
//abc
//XYZ
protected void setError ()
エラーが発生したことを示します。
protected です。
独自にサブクラスを作ることは少ないと思いますので、コード例は割愛します。
void write (char[] buf)
文字の配列を書き込みます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.write(new char[]{'a', 'b', 'c'});
writer.write(new char[]{'X', 'Y', 'Z'});
}
System.out.println(out); // abcXYZ
void write (char[] buf, int off, int len)
文字の配列の一部を書き込みます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final char[] buf = {'a', 'b', 'c', 'd'};
writer.write(buf, 0, 1);
writer.println();
writer.write(buf, 0, 2);
writer.println();
writer.write(buf, 0, 3);
writer.println();
writer.write(buf, 0, 4);
writer.println();
}
System.out.print(out);
// 結果
// ↓
//a
//ab
//abc
//abcd
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final char[] buf = {'a', 'b', 'c', 'd'};
writer.write(buf, 0, 4);
writer.println();
writer.write(buf, 1, 3);
writer.println();
writer.write(buf, 2, 2);
writer.println();
writer.write(buf, 3, 1);
writer.println();
}
System.out.print(out);
// 結果
// ↓
//abcd
//bcd
//cd
//d
void write (int c)
単一の文字を書き込みます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.write('a');
writer.write('b');
writer.write('c');
}
System.out.println(out); // abc
void write (String s)
文字列を書き込みます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
writer.write("abc");
writer.write("XYZ");
}
System.out.println(out); // abcXYZ
void write (String s, int off, int len)
文字列の一部を書き込みます。
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final var s = "abcd";
writer.write(s, 0, 1);
writer.println();
writer.write(s, 0, 2);
writer.println();
writer.write(s, 0, 3);
writer.println();
writer.write(s, 0, 4);
writer.println();
}
System.out.print(out);
// 結果
// ↓
//a
//ab
//abc
//abcd
final var out = new StringWriter();
try (final var writer = new PrintWriter(out)) {
final var s = "abcd";
writer.write(s, 0, 4);
writer.println();
writer.write(s, 1, 3);
writer.println();
writer.write(s, 2, 2);
writer.println();
writer.write(s, 3, 1);
writer.println();
}
System.out.print(out);
// 結果
// ↓
//abcd
//bcd
//cd
//d
Writerで宣言されたメソッド
nullWriter
「Java API 使用例 : Writer」をご参照ください。