java.io
クラス PushbackReader

java.lang.Object
  java.io.Reader
      java.io.FilterReader
          java.io.PushbackReader

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

Closeable, Readable

public class PushbackReader
extends FilterReader

文字をストリームにプッシュバックできる文字ストリームリーダです。

導入されたバージョン:

JDK1.1

フィールドの概要

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

in

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

lock

コンストラクタの概要

PushbackReader(Reader in)
1 文字分のプッシュバックバッファを持つ、新しいプッシュバックリーダを作成します。

PushbackReader(Reader in, int size)
指定されたサイズのプッシュバックバッファを持つ、新しいプッシュバックリーダを作成します。

メソッドの概要

void	close() ストリームを閉じます。
void	mark(int readAheadLimit) ストリーム内の現在の位置にマークを設定します。
boolean	markSupported() このストリームが mark() オペレーションをサポートするかどうか、サポートしないのはどれなのかを調べます。
int	read() 単一の文字を読み込みます。
int	read(char[] cbuf, int off, int len) 配列の一部に文字を読み込みます。
boolean	ready() このストリームが読み込み可能かどうかを判定します。
void	reset() ストリームをリセットします。
long	skip(long n) 文字をスキップします。
void	unread(char[] cbuf) プッシュバックバッファの先頭にその文字配列をコピーして、文字配列をプッシュバックします。
void	unread(char[] cbuf, int off, int len) プッシュバックバッファの先頭にその文字配列の一部をコピーして、文字配列の一部をプッシュバックします。
void	unread(int c) 単一の文字をプッシュバックします。

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

read, read

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

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

コンストラクタの詳細

PushbackReader

public PushbackReader(Reader in,
                      int size)

指定されたサイズのプッシュバックバッファを持つ、新しいプッシュバックリーダを作成します。

パラメータ:

in - 文字の読み込み元のリーダ

size - プッシュバックバッファのサイズ

例外:

IllegalArgumentException - サイズが 0 以下の場合

PushbackReader

public PushbackReader(Reader in)

1 文字分のプッシュバックバッファを持つ、新しいプッシュバックリーダを作成します。

パラメータ:

in - 文字の読み込み元のリーダ

メソッドの詳細

read

public int read()
         throws IOException

単一の文字を読み込みます。

オーバーライド:

クラス FilterReader 内の read

戻り値:

読み込まれた文字。ストリームの終わりに達した場合は -1

例外:

IOException - 入出力エラーが発生した場合

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException

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

オーバーライド:

クラス FilterReader 内の read

パラメータ:

cbuf - 転送先バッファ

off - 文字の書き込み開始オフセット

len - 読み込む文字の最大数

戻り値:

読み込まれた文字数。ストリームの終わりに達した場合は -1

例外:

IOException - 入出力エラーが発生した場合

unread

public void unread(int c)
            throws IOException

単一の文字をプッシュバックします。

パラメータ:

c - プッシュバックする文字

例外:

IOException - プッシュバックがいっぱいの場合、または他の入出力エラーが発生した場合

unread

public void unread(char[] cbuf,
                   int off,
                   int len)
            throws IOException

プッシュバックバッファの先頭にその文字配列の一部をコピーして、文字配列の一部をプッシュバックします。このメソッドが復帰すると、次に読み込まれる文字は値 cbuf[off]、その次の文字は値 cbuf[off+1] と、値を順次保持していきます。

パラメータ:

cbuf - 文字配列

off - 文字のプッシュバック開始オフセット

len - プッシュバックする文字数

例外:

IOException - プッシュバックバッファに十分なスペースがない場合、または他の入出力エラーが発生した場合

unread

public void unread(char[] cbuf)
            throws IOException

プッシュバックバッファの先頭にその文字配列をコピーして、文字配列をプッシュバックします。このメソッドが復帰すると、次に読み込まれる文字は値 cbuf[0]、その次の文字は値 cbuf[1] と、値を順次保持していきます。

パラメータ:

cbuf - プッシュバックする文字配列

例外:

IOException - プッシュバックバッファに十分なスペースがない場合、または他の入出力エラーが発生した場合

ready

public boolean ready()
              throws IOException

このストリームが読み込み可能かどうかを判定します。

オーバーライド:

クラス FilterReader 内の ready

戻り値:

次の read() が入力をブロックしないのが確実な場合は true、そうでない場合は false。false が返されても、次の読み込みが確実にブロックするというわけでない

例外:

IOException - 入出力エラーが発生した場合

mark

public void mark(int readAheadLimit)
          throws IOException

ストリーム内の現在の位置にマークを設定します。PushbackReader クラスの mark は常に例外をスローします。

オーバーライド:

クラス FilterReader 内の mark

パラメータ:

readAheadLimit - マークを保持しながら読み込むことができる文字数の上限。この数の文字を読み込んだあとでストリームをリセットしようとすると失敗する場合がある

例外:

IOException - mark メソッドはサポートされていないので、常にスローされる

reset

public void reset()
           throws IOException

ストリームをリセットします。PushbackReader の reset メソッドは常に例外をスローします。

オーバーライド:

クラス FilterReader 内の reset

例外:

IOException - reset メソッドはサポートされていないので、常にスローされる

markSupported

public boolean markSupported()

このストリームが mark() オペレーションをサポートするかどうか、サポートしないのはどれなのかを調べます。

オーバーライド:

クラス FilterReader 内の markSupported

戻り値:

このストリームが mark オペレーションをサポートする場合に限り true

close

public void close()
           throws IOException

ストリームを閉じます。

定義:

インタフェース Closeable 内の close

オーバーライド:

クラス FilterReader 内の close

例外:

IOException - 入出力エラーが発生した場合

skip

public long skip(long n)
          throws IOException

文字をスキップします。このメソッドは、文字が使用可能になるか、入出力エラーが発生するか、ストリームの終わりに達するまでブロックします。

オーバーライド:

クラス FilterReader 内の skip

パラメータ:

n - スキップする文字の数

戻り値:

実際にスキップされた文字の数

例外:

IllegalArgumentException - n が負の場合

IOException - 入出力エラーが発生した場合