com.docomostar.io
クラス BufferedReader

Object
  java.io.Reader
      com.docomostar.io.BufferedReader

public class BufferedReader
extends java.io.Reader

文字列、行、配列をバッファリングして、文字型データを読み出すReaderクラスです。

ストリーム(Reader)を効率よく読み込むため、 このクラスのインスタンスはそれぞれ文字配列のバッファを持ちます。

導入されたバージョン:

Star-1.0

フィールドの概要

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

lock

コンストラクタの概要

BufferedReader(java.io.Reader in)
標準のバッファサイズのBufferedReaderを生成します。

BufferedReader(java.io.Reader in, int size)
指定されたバッファサイズのBufferedReaderを生成します。

メソッドの概要

void	close() ストリームをクローズします。
void	mark(int readAheadLimit) ストリームの現在の位置をマークします。
boolean	markSupported() mark操作をサポートするか否かを調べます。
int	read() 1文字読み込みます。
int	read(char[] buf, int off, int len) 配列の一部に文字を読み込みます。
String	readLine() 1行読み込みます。
boolean	ready() ストリームが読み込み可能かどうかを調べます。
void	reset() 最後にマークした位置に戻ります。
long	skip(long n) 文字をスキップします。

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

read

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

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

コンストラクタの詳細

BufferedReader

public BufferedReader(java.io.Reader in)

標準のバッファサイズのBufferedReaderを生成します。

標準のバッファサイズは、機種依存です。

パラメータ:

in - 生成するBufferedReaderの入力元のストリームを指定します。

例外:

NullPointerException -
引数 in が null の場合に発生します。

BufferedReader

public BufferedReader(java.io.Reader in,
                      int size)

指定されたバッファサイズのBufferedReaderを生成します。

パラメータ:

in - 生成するBufferedReaderの入力元のストリームを指定します。

size - バッファサイズを文字数で指定します。

例外:

NullPointerException -
引数 in が null の場合に発生します。

IllegalArgumentException -
引数 size が 0 以下の場合に発生します。

メソッドの詳細

read

public int read()
         throws java.io.IOException

1文字読み込みます。

オーバーライド:

クラス java.io.Reader 内の read

戻り値:

読み込んだ文字をint(0x0000 - 0xFFFF)として返します。 ストリームの終端に達して返す文字がない場合、-1 を返します。

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

java.io.IOException -
I/O エラーが発生した場合に発生します。

read

public int read(char[] buf,
                int off,
                int len)
         throws java.io.IOException

配列の一部に文字を読み込みます。

指定された文字数を読み込んだ場合、 入力元のストリームの終端に達した場合、 および入力元のストリームのreadyメソッドがfalseを返した場合には、 配列に空きがあってもそれ以上の文字の読み込みは行いません。

定義:

クラス java.io.Reader 内の read

パラメータ:

buf - 読み込んだ文字を格納する配列を指定します。

off - 配列中の文字の読み込み開始位置を指定します。

len - 読み込む文字数の最大数を指定します。

戻り値:

実際に読み込んだ文字数を返します。 ストリームの終端に達して返す文字がない場合、-1 を返します。

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

NullPointerException -
引数 buf が null の場合に発生します。

IndexOutOfBoundsException -
引数 off が 0 未満の場合、 引数 len が 0 未満の場合、 off+len が配列 buf の長さを超える場合に発生します。

java.io.IOException -
I/O エラーが発生した場合に発生します。

readLine

public String readLine()
                throws java.io.IOException

1行読み込みます。 行の終わりは、LF('¥n')、CR('¥r')またはCRLF("¥r¥n")により判断されます。

戻り値:

読み込んだ行を返します。 行の終わりを示す文字は含みません。 ストリームの終端に達して行を読み込めない場合、null を返します。

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

java.io.IOException -
I/O エラーが発生した場合に発生します。

skip

public long skip(long n)
          throws java.io.IOException

文字をスキップします。

オーバーライド:

クラス java.io.Reader 内の skip

パラメータ:

n - スキップする文字数を指定します。

戻り値:

実際にスキップした文字数を返します。

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

IllegalArgumentException -
引数 n が 0 未満の場合に発生します。

java.io.IOException -
I/O エラーが発生した場合に発生します。

ready

public boolean ready()
              throws java.io.IOException

ストリームが読み込み可能かどうかを調べます。 バッファが空でない場合、 入力元のストリームのreadyメソッドがtrueを返す場合、trueを返します。

オーバーライド:

クラス java.io.Reader 内の ready

戻り値:

次のreadメソッドがブロックしないことを保証する場合、 trueを返します。 そうでない場合、falseを返します。 falseを返した場合、 必ずしも次のreadメソッドがブロックするとは限りません。

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

java.io.IOException -
I/O エラーが発生した場合に発生します。

markSupported

public boolean markSupported()

mark操作をサポートするか否かを調べます。 mark操作をサポートするため、本メソッドは常にtrueを返します。

オーバーライド:

クラス java.io.Reader 内の markSupported

戻り値:

常に true を返します。

mark

public void mark(int readAheadLimit)
          throws java.io.IOException

ストリームの現在の位置をマークします。 resetメソッドを呼び出すと、 マークした位置から再度読み込みを行うことができます。

オーバーライド:

クラス java.io.Reader 内の mark

パラメータ:

readAheadLimit - マーク位置を保持して読み込むことのできる最大文字数を指定します。 マーク後にこの文字数以上の文字を読み込むと、 resetメソッドが失敗することがあります。 バッファサイズ以上の数を指定すると、バッファが拡張されます。

関連項目:

reset()

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

IllegalArgumentException -
引数 readAheadLimit が 0 未満の場合に発生します。

java.io.IOException -
I/O エラーが発生した場合に発生します。

reset

public void reset()
           throws java.io.IOException

最後にマークした位置に戻ります。

オーバーライド:

クラス java.io.Reader 内の reset

関連項目:

mark(int)

例外:

java.io.IOException -
このオブジェクトが既にクローズされている場合に発生します。

java.io.IOException -
マークされていない場合、マークした位置に戻れない場合に発生します。

close

public void close()
           throws java.io.IOException

ストリームをクローズします。
ストリームがクローズされると、 すべてのreadメソッド、readLine、skip、ready、mark、resetメソッドは、 IOExceptionをスローします。 既にクローズされているストリームをクローズしても何も起こりません。

定義:

クラス java.io.Reader 内の close

例外:

java.io.IOException -
I/O エラーが発生した場合に発生します。