Writer (Java Platform SE 8)

java.lang.Object
- java.io.Writer

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

Closeable、Flushable, Appendable, AutoCloseable

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

BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, PipedWriter, PrintWriter, StringWriter
```
public abstract class Writer
extends Object
implements Appendable, Closeable, Flushable
```
文字ストリームに書き込むための抽象クラスです。サブクラスでの実装が必要なメソッドは、write(char[], int, int)、flush()、およびclose()だけです。ただし、ほとんどのサブクラスは、効率性の向上または機能の追加、あるいはその両方のために、ここで定義されるメソッドの一部をオーバーライドします。

導入されたバージョン:

JDK1.1

関連項目:

Writer, BufferedWriter, CharArrayWriter, FilterWriter, OutputStreamWriter, FileWriter, PipedWriter, PrintWriter, StringWriter, Reader

フィールドのサマリー

フィールド
修飾子と型フィールドと説明

protected Object lock
このストリームに対する処理の同期に使用するオブジェクトです。

フィールド
修飾子と型	フィールドと説明
`protected Object`	`lock` このストリームに対する処理の同期に使用するオブジェクトです。

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

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`Writer()` ライター自体でクリティカル・セクションが同期する文字ストリーム・ライターを新しく作成します。
`protected`	`Writer(Object lock)` 指定されたオブジェクトでクリティカル・セクションが同期する文字ストリーム・ライターを新しく作成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`Writer`	`append(char c)` 指定された文字をこのライターに追加します。
`Writer`	`append(CharSequence csq)` 指定された文字シーケンスをこのライターに追加します。
`Writer`	`append(CharSequence csq, int start, int end)` 指定された文字シーケンスのサブシーケンスをこのライターに追加します。
`abstract void`	`close()` ストリームを最初にフラッシュして、閉じます。
`abstract void`	`flush()` ストリームをフラッシュします。
`void`	`write(char[] cbuf)` 文字の配列を書き込みます。
`abstract void`	`write(char[] cbuf, int off, int len)` 文字の配列の一部を書き込みます。
`void`	`write(int c)` 単一の文字を書き込みます。
`void`	`write(String str)` 文字列を書き込みます。
`void`	`write(String str, int off, int len)` 文字列の一部を書き込みます。

クラス java.lang.Objectから継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - lock
```
protected Object lock
```
    このストリームに対する処理の同期に使用するオブジェクトです。効率を良くするため、文字ストリーム・オブジェクトは、ほかのオブジェクトを使ってクリティカル・セクションを保護することができます。そのため、サブクラスではthisではなくこのフィールドのオブジェクトを使用するか、同期化したメソッドを使用するようにしてください。
- コンストラクタの詳細
  - Writer
```
protected Writer()
```
    ライター自体でクリティカル・セクションが同期する文字ストリーム・ライターを新しく作成します。
  - Writer
```
protected Writer(Object lock)
```
    指定されたオブジェクトでクリティカル・セクションが同期する文字ストリーム・ライターを新しく作成します。
    
    パラメータ:
    
    lock - 同期するオブジェクト
- メソッドの詳細
  - write
```
public void write(int c)
           throws IOException
```
    単一の文字を書き込みます。書き込まれる文字は、指定された整数値の下位16ビットに格納されます。上位16ビットは無視されます。
    有効な単一文字の出力をサポートするためのサブクラスでは、このメソッドをオーバーライドします。
    
    パラメータ:
    
    c - 書き込まれる文字を指定するint
    
    例外:
    
    IOException - 入出力エラーが発生した場合
  - write
```
public void write(char[] cbuf)
           throws IOException
```
    文字の配列を書き込みます。
    
    パラメータ:
    
    cbuf - 書き込まれる文字の配列
    
    例外:
    
    IOException - 入出力エラーが発生した場合
  - write
```
public abstract void write(char[] cbuf,
                           int off,
                           int len)
                    throws IOException
```
    文字の配列の一部を書き込みます。
    
    パラメータ:
    
    cbuf - 文字の配列
    
    off - 文字の書込み開始オフセット
    
    len - 書き込む文字数
    
    例外:
    
    IOException - 入出力エラーが発生した場合
  - write
```
public void write(String str)
           throws IOException
```
    文字列を書き込みます。
    
    パラメータ:
    
    str - 書き込まれる文字列
    
    例外:
    
    IOException - 入出力エラーが発生した場合
  - write
```
public void write(String str,
                  int off,
                  int len)
           throws IOException
```
    文字列の一部を書き込みます。
    
    パラメータ:
    
    str - 文字列
    
    off - 文字の書込み開始オフセット
    
    len - 書き込む文字数
    
    例外:
    
    IndexOutOfBoundsException - offが負の場合、lenが負の場合、またはoff+lenが負であるか、指定された文字列の長さよりも大きい場合
    
    IOException - 入出力エラーが発生した場合
  - append
```
public Writer append(CharSequence csq)
              throws IOException
```
    指定された文字シーケンスをこのライターに追加します。
    このメソッドをout.append(csq)の形式で呼び出した場合、次の呼び出しとまったく同様に動作します。
```
     out.write(csq.toString()) 
```
    文字シーケンスcsqに対するtoStringの指定に応じて、シーケンス全体が追加されないこともあります。たとえば、文字バッファのtoStringメソッドを呼び出した場合、返されるサブシーケンスの内容はそのバッファの位置とリミットによって決まります。
    定義:
    
    append、インタフェース: Appendable
    
    パラメータ:
    
    csq - 追加する文字シーケンス。csqがnullの場合は、このライターに「null」という4文字が追加される。
    
    戻り値:
    
    このライター
    
    例外:
    
    IOException - 入出力エラーが発生した場合
    
    導入されたバージョン:
    
    1.5
  - append
```
public Writer append(CharSequence csq,
                     int start,
                     int end)
              throws IOException
```
    指定された文字シーケンスのサブシーケンスをこのライターに追加します。Appendable。
    csqがnullでないときに、このメソッドをout.append(csq, start, end)の形式で呼び出した場合、次の呼び出しとまったく同様に動作します。
```
     out.write(csq.subSequence(start, end).toString()) 
```
    定義:
    
    append、インタフェース: Appendable
    
    パラメータ:
    
    csq - サブシーケンスの追加元の文字シーケンス。csqがnullの場合は、csqに「null」という4文字が含まれているかのように文字が追加される。
    
    start - サブシーケンスの最初の文字のインデックス
    
    end - サブシーケンスの最後の文字のあとに続く文字のインデックス
    
    戻り値:
    
    このライター
    
    例外:
    
    IndexOutOfBoundsException - startまたはendが負の値の場合、startがendよりも大きい場合、あるいはendがcsq.length()よりも大きい場合
    
    IOException - 入出力エラーが発生した場合
    
    導入されたバージョン:
    
    1.5
  - append
```
public Writer append(char c)
              throws IOException
```
    指定された文字をこのライターに追加します。
    このメソッドをout.append(c)の形式で呼び出した場合、次の呼び出しとまったく同様に動作します。
```
     out.write(c) 
```
    定義:
    
    append、インタフェース: Appendable
    
    パラメータ:
    
    c - 追加する16ビット文字
    
    戻り値:
    
    このライター
    
    例外:
    
    IOException - 入出力エラーが発生した場合
    
    導入されたバージョン:
    
    1.5
  - flush
```
public abstract void flush()
                    throws IOException
```
    ストリームをフラッシュします。ストリームが各種のwrite()メソッドにより書き込まれた文字をバッファに保存してある場合は、これらの文字の目的の転送先にただちに文字を書き込みます。さらに、転送先が別の文字ストリームまたはバイト・ストリームの場合は、この送信先をフラッシュします。つまり、1つのflush()の呼出しで、関連するWriterおよびOutputStreamのすべてのバッファをフラッシュします。
    このストリームの目的の転送先が、ベースとなるオペレーティング・システムによって提供される抽象化オブジェクト(ファイルなど)である場合、ストリームをフラッシュすることで、それまでにストリームに書き込まれたバイトがオペレーティング・システムに渡されて書き込まれることは保証されますが、ディスク・ドライブなどの物理デバイスに実際に書き込まれることは保証されません。
    
    定義:
    
    flush、インタフェース: Flushable
    
    例外:
    
    IOException - 入出力エラーが発生した場合
  - close
```
public abstract void close()
                    throws IOException
```
    ストリームを最初にフラッシュして、閉じます。ストリームが閉じられたあとにwrite()またはflush()を呼び出すと、IOExceptionがスローされます。すでに閉じられているストリームを閉じても、何の影響もありません。
    
    定義:
    
    close、インタフェース: Closeable
    
    定義:
    
    close、インタフェース: AutoCloseable
    
    例外:
    
    IOException - 入出力エラーが発生した場合

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

クラスWriter

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

lock

コンストラクタの詳細

Writer

Writer

メソッドの詳細

write

write

write

write

write

append

append

append

flush

close