JavaTM Platform
Standard Ed. 6

java.io
クラス StringReader

java.lang.Object
  上位を拡張 java.io.Reader
      上位を拡張 java.io.StringReader
すべての実装されたインタフェース:
Closeable, Readable

public class StringReader
extends Reader

ソースが文字列の文字ストリームです。

導入されたバージョン:
JDK1.1

フィールドの概要
 
クラス java.io.Reader から継承されたフィールド
lock
 
コンストラクタの概要
StringReader(String s)
          新しい文字列リーダーを作成します。
 
メソッドの概要
 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 ns)
          ストリーム内の指定された数の文字をスキップします。
 
クラス java.io.Reader から継承されたメソッド
read, read
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

StringReader

public StringReader(String s)
新しい文字列リーダーを作成します。

パラメータ:
s - 文字ストリームを提供する文字列
メソッドの詳細

read

public int read()
         throws IOException
単一の文字を読み込みます。

オーバーライド:
クラス Reader 内の read
戻り値:
読み込まれた文字。ストリームの終わりに達した場合は -1
例外:
IOException - 入出力エラーが発生した場合

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
配列の一部に文字を読み込みます。

定義:
クラス Reader 内の read
パラメータ:
cbuf - 転送先バッファー
off - 文字の書き込み開始オフセット
len - 読み込む文字の最大数
戻り値:
読み込まれた文字数。ストリームの終わりに達した場合は -1
例外:
IOException - 入出力エラーが発生した場合

skip

public long skip(long ns)
          throws IOException
ストリーム内の指定された数の文字をスキップします。スキップされた文字の数を返します。

Reader スーパークラスの skip メソッドが例外をスローしても、ns パラメータは負になる可能性があります。ns が負の値であれば、ストリームは後ろへスキップします。負の戻り値は、後ろへスキップすることを示します。文字列の先頭を超えて後ろへスキップすることはできません。

文字列全体が読み込まれたかスキップされた場合、このメソッドは何も実行せずに、常に 0 を返します。

オーバーライド:
クラス Reader 内の skip
パラメータ:
ns - スキップする文字数
戻り値:
実際にスキップした文字数
例外:
IOException - 入出力エラーが発生した場合

ready

public boolean ready()
              throws IOException
このストリームが読み込み可能かどうかを判定します。

オーバーライド:
クラス Reader 内の ready
戻り値:
次の read() が入力をブロックしないことを保証できる場合は true
例外:
IOException - ストリームが閉じられた場合

markSupported

public boolean markSupported()
このストリームが、実行する mark() オペレーションをサポートするかどうかを通知します。

オーバーライド:
クラス Reader 内の markSupported
戻り値:
このストリームが mark オペレーションをサポートする場合に限り true

mark

public void mark(int readAheadLimit)
          throws IOException
ストリームの現在位置にマークを設定します。以降の reset() の呼び出しでは、ストリームはこの位置に再配置されます。

オーバーライド:
クラス Reader 内の mark
パラメータ:
readAheadLimit - マークを保持しながら読み込むことができる文字数の上限。文字列からストリームに入力されるので、実際の上限はない。そのため、この引数は負の値であってはならない。そうでない場合は、無視される
例外:
IllegalArgumentException - readAheadLimit が負の値の場合
IOException - 入出力エラーが発生した場合

reset

public void reset()
           throws IOException
直前のマーク位置にストリームをリセットします。マークが設定されていない場合は、文字列の先頭にリセットします。

オーバーライド:
クラス Reader 内の reset
例外:
IOException - 入出力エラーが発生した場合

close

public void close()
ストリームを閉じて、それに関連するすべてのシステムリソースを解放します。ストリームが閉じられたあとに read()、ready()、mark()、または reset() を呼び出すと、IOException がスローされます。すでに閉じられているストリームを閉じても、何の影響もありません。

定義:
インタフェース Closeable 内の close
定義:
クラス Reader 内の close

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。