全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

クラス java.io.Reader 

java.lang.Object
   |
   +----java.io.Reader
public abstract class Reader
extends Object
文字ストリームを読み込むための抽象クラスです。サブクラスで実装しなければならないメソッドは、read(char[], int, int) と close() だけです。ただし、ほとんどのサブクラスでは、効率を高めるか機能を追加するために、またはその両方のために、ここで定義するメソッドの一部をオーバーライドします。

参照:
BufferedReader, LineNumberReader, CharArrayReader, InputStreamReader, FileReader, FilterReader, PushbackReader, PipedReader, StringReader, Writer

Variable Index

o lock
このストリームでオペレーションを同期させるのに使うオブジェクト。

Constructor Index

o Reader()
その重要なセクションがリーダ自体で同期する、新しい文字ストリームリーダを作成する。
o Reader(Object)
その重要なセクションが指定のオブジェクトで同期する、新しい文字ストリームリーダを作成する。

Method Index

o close()
ストリームをクローズする。
o mark(int)
ストリームの現在の位置をマークする。
o markSupported()
このストリームが mark() オペレーションをサポートするかどうかを示す。
o read()
単独の文字を読み込む。
o read(char[])
配列に文字を読み込む。
o read(char[], int, int)
配列の一部に文字を読み込む。
o ready()
このストリームが読み込める状態になっているかどうかを示す。
o reset()
ストリームをリセットする。
o skip(long)
文字をスキップする。

Variables

o lock 
  protected Object lock
このストリームでオペレーションを同期させるのに使うオブジェクトです。効率のため、文字ストリームのオブジェクトでは、それ以外のオブジェクトを使って重要なセクションを保護することができます。そのため、サブクラスでは、 this や同期メソッドよりも、このフィールドのオブジェクトを使用します。

Constructors

o Reader 
  protected Reader()
その重要なセクションがリーダ自体で同期する、新しい文字ストリームリーダを作成します。

o Reader 
  protected Reader(Object lock)
その重要なセクションが指定のオブジェクトで同期する、新しい文字ストリームリーダを作成します。

Methods

o read 
  public int read() throws IOException
単独の文字を読み込みます。このメソッドでは、文字が来るまで、I/O エラーが発生するまで、またはストリームが終わるまで制御をブロックします。

有効な単一文字入力をサポートするためのサブクラスでは、このメソッドをオーバーライドします。

返り値:
読み込んだ文字を 0 から 16383 (0x00-0xffff)の範囲の整数として、またストリームが終わった場合は -1。
例外: IOException
I/O エラーが発生した場合。
o read 
  public int read(char cbuf[]) throws IOException
配列に文字を読み込みます。このメソッドでは、文字が来るまで、I/O エラーが発生するまで、またはストリームが終わるまでブロックします。

パラメータ:
cbuf - 宛先のバッファ
返り値:
読み込んだバイト数。ストリームが終わった場合は -1。
例外: IOException
I/O エラーが発生した場合。
o read 
  public abstract int read(char cbuf[],
                           int off,
                           int len) throws IOException
配列の一部に文字を読み込みます。このメソッドでは、入力が来るまで、I/O エラーが発生するまで、またはストリームが終わるまでブロックします。

パラメータ:
cbuf - 宛先のバッファ
off - 文字の保管を始めるオフセット
len - 読み込む文字の最大数
返り値:
読み込んだ文字数。ストリームが終わった場合は -1。
例外: IOException
I/O エラーが発生した場合。
o skip 
  public long skip(long n) throws IOException
文字をスキップします。このメソッドでは、文字が来るまで、I/O エラーが発生するまで、またはストリームが終わるまでブロックします。

パラメータ:
n - スキップする文字数
返り値:
実際にスキップした文字数
例外: IOException
I/O エラーが発生した場合。
o ready 
  public boolean ready() throws IOException
このストリームが読み込める状態になっているかどうかを示します。

返り値:
次の read() が入力をブロックしないのが確実なら true 、そうでなければ false 。false を返しても、次の読み込みがブロックするのが確実というわけでないので注意する。
例外: IOException
I/Oエラーが発生した場合。
o markSupported 
  public boolean markSupported()
このストリームが mark() オペレーションをサポートするかどうかを示します。

o mark 
  public void mark(int readAheadLimit) throws IOException
ストリームの現在の位置をマークします。その後の reset() への呼び出しでは、ストリームをこの位置に配置しようとします。すべての文字入力ストリームで mark() オペレーションをサポートするわけではありません。

パラメータ:
readAheadLimit - マークを保持したまま読み込める文字数の限度。この文字をたくさん読み込むと、ストリームをリセットしようとしても失敗することがある。
例外: IOException
ストリームが mark() をサポートしない場合、またはその他の I/O エラーが発生した場合。
o reset 
  public void reset() throws IOException
ストリームをリセットします。ストリームがマークされていると、そのマークに再配置しようとします。マークされていなければ、個々のストリームに適したなんらかの方法で、たとえばスタート位置に再配置してリセットを試みます。すべての文字入力ストリームで reset() オペレーションをサポートするわけではありません。また、 mark() をサポートしなくても reset() をサポートするものもあります。

例外: IOException
そのストリームがマークされていない場合、マークが無効になっている場合、そのストリームでは reset() をサポートしてない場合、または I/O エラーが発生した場合。
o close 
  public abstract void close() throws IOException
ストリームをクローズします。ストリームをいったんクローズすると、その後で read()、 ready()、mark()、または reset() を呼び出すと IOException をスローします。ただし、前にクローズしたストリームには影響はありません。

例外: IOException
I/O エラーが発生した場合。 
全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス