クラスPushbackReader

java.lang.Object

java.io.Reader

java.io.FilterReader

java.io.PushbackReader

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

Closeable, AutoCloseable, Readable

public class PushbackReader extends FilterReader

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

導入されたバージョン:

1.1

フィールドのサマリー

クラスで宣言されたフィールド FilterReader

in

修飾子と型	フィールド	説明
protected Reader	in	ベースとなる文字入力ストリームです。

クラスリーダーで宣言されたフィールド

lock

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

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

コンストラクタ

コンストラクタ	説明
PushbackReader(Reader in)	1文字分のプッシュバック・バッファを持つ、新しいプッシュバック・リーダーを作成します。
PushbackReader(Reader in, int size)	指定されたサイズのプッシュバック・バッファを持つ、新しいプッシュバック・リーダーを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
void	close()	ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。
void	mark(int readAheadLimit)	ストリームの現在位置にマークを設定します。
boolean	markSupported()	このストリームがmark()オペレーションをサポートするかどうか、サポートしないのはどれなのかを調べます。
int	read()	単一の文字を読み込みます。
boolean	ready()	このストリームが読込み可能かどうかを判定します。
void	reset()	ストリームをリセットします。
void	unread(char[] cbuf)	プッシュバック・バッファの先頭に文字配列をコピーすることによって、文字配列をプッシュ・バックします。
void	unread(char[] cbuf, int off, int len)	プッシュバック・バッファの先頭に文字配列の一部をコピーすることによって、それらの文字をプッシュ・バックします。
void	unread(int c)	プッシュバック・バッファの先頭に1文字をコピーすることによって、その文字をプッシュ・バックします。

クラスで宣言されたメソッド FilterReader

read, skip

修飾子と型	メソッド	説明
int	read(char[] cbuf, int off, int len)	配列の一部に文字を読み込みます。
long	skip(long n)	文字をスキップします。

クラスReaderで宣言されたメソッド

nullReader, of, read, read, readAllAsString, readAllLines, transferTo

修飾子と型	メソッド	説明
static Reader	nullReader()	文字を読み取らない新しいReaderを返します。
static Reader	of(CharSequence cs)	CharSequenceから文字を読み取るReaderを返します。
int	read(char[] cbuf)	配列に文字を読み込みます。
int	read(CharBuffer target)	指定されたcharバッファにcharを読み込みます。
String	readAllAsString()	残りの文字をすべて文字列に読み込みます。
List<String>	readAllLines()	残りの文字をすべてテキスト行として読み取ります。
long	transferTo(Writer out)	このリーダーからすべての文字を読み込み、指定されたライターに読み込まれた順番で書き込みます。

クラスオブジェクトで宣言されたメソッド

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

修飾子と型	メソッド	説明
protected Object	clone()	このオブジェクトのコピーを作成して、返します。
boolean	equals(Object obj)	このオブジェクトと他のオブジェクトが等しいかどうかを示します。
protected void	finalize()	削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。 最終決定は非推奨であり、将来のリリースで削除される可能性があります。
final Class<?>	getClass()	このObjectの実行時クラスを返します。
int	hashCode()	このオブジェクトに対するハッシュ・コード値を返します。
final void	notify()	このオブジェクトのモニターで待機中のスレッドを1つ再開します。
final void	notifyAll()	このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
String	toString()	オブジェクトの文字列表現を返します。
final void	wait()	現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
final void	wait(long timeoutMillis)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
final void	wait(long timeoutMillis, int nanos)	現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

コンストラクタの詳細

PushbackReader

public PushbackReader(Reader in, int size)

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

パラメータ:

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

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

スロー:

IllegalArgumentException - size <= 0の場合

PushbackReader

public PushbackReader(Reader in)

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

パラメータ:

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

メソッドの詳細

read

public int read() throws IOException

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

オーバーライド:

read、クラスFilterReader

戻り値:

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

スロー:

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

unread

public void unread(int c) throws IOException

プッシュバック・バッファの先頭に1文字をコピーすることによって、その文字をプッシュ・バックします。 このメソッドが復帰すると、次に読み込まれる文字は値(char)cを持ちます。

パラメータ:

c - プッシュ・バックされる文字を表すint値

スロー:

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

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

オーバーライド:

ready、クラスFilterReader

戻り値:

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

スロー:

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

mark

public void mark(int readAheadLimit) throws IOException

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

オーバーライド:

mark、クラスFilterReader

パラメータ:

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

スロー:

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

reset

public void reset() throws IOException

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

オーバーライド:

reset、クラスFilterReader

スロー:

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

markSupported

public boolean markSupported()

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

オーバーライド:

markSupported、クラスFilterReader

戻り値:

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

close

public void close() throws IOException

ストリームを閉じて、それに関連するすべてのシステム・リソースを解放します。 ストリームを閉じたあとに、さらにread()、unread()、ready()、またはskip()を呼び出すと、IOExceptionがスローされます。 すでに閉じられているストリームを閉じても、何の影響もありません。 このメソッドは、リーダーで別のスレッドがブロックされている間はブロックされます。

定義:

close、インタフェースAutoCloseable

定義:

close、インタフェースCloseable

定義:

close、クラスReader

スロー:

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