java.io
クラス InputStreamReader

java.lang.Object
  java.io.Reader
      java.io.InputStreamReader

public class InputStreamReader
extends Reader

バイトによる入力を行う InputStream クラスと文字による入力を行う Reader クラスの仲立的な処理を持ったクラスです。 入力ストリームと必要に応じて文字エンコーディング名を渡すと、渡した入力ストリームから Reader クラスの規約に従った読み出しを行えます。 この際の文字エンコーディングは、文字エンコーディングを指定しなかった場合はプラットフォームに依存したデフォルトの文字エンコーディングを使用します。 文字エンコーディングを指定した場合はその文字エンコーディングを使用します。

このクラスと逆に OutputStream クラスと文字による出力を行う Writer クラスの仲立ち的な処理を行う OutputStreamWriter クラスが用意されています。

導入されたバージョン:

CLDC 1.0

関連項目:

InputStream, OutputStreamWriter, System.getProperty(java.lang.String)

InputStreamReader

public InputStreamReader(InputStream is)

入力ストリームを受け取ってオブジェクトを構築します。 文字エンコーディングはプラットフォームのデフォルトを使用します。

パラメータ:

is - 処理を行う対象の入力ストリームを渡します。

関連項目:

System.getProperty(String)

InputStreamReader

public InputStreamReader(InputStream is,
                         String encoding)
                  throws UnsupportedEncodingException

入力ストリームと文字エンコーディング名を受け取ってオブジェクトを構築します。 指定された文字エンコーディングをサポートしていない場合は UnsupportedEncodingException を throw します。

パラメータ:

is - 処理を行う対象の入力ストリームを渡します。

encoding - 使用する文字エンコーディング名を渡します。

例外:

UnsupportedEncodingException - 指定された文字エンコーディング名をサポートしていない場合に throw します。

read

public int read()
         throws IOException

文字を１つ読み出します。 このメソッドは文字の読み出しが終了するか、例外が throw されるかあるいは終端に達するまでブロックします。

オーバーライド:

クラス Reader 内の read

戻り値:

読み出した１文字を int 型の値（0x0000 〜 0xffff）として返します。これは読み出した char 型の値を int 型でキャストした値を取得するのと等価です。

例外:

IOException - データの読み出し時に何らかの障害が発生した場合に throw します。

関連項目:

OutputStreamWriter.write(int)

read

public int read(char[] data,
                int index,
                int length)
         throws IOException

ストリームから指定された数の文字を渡された char 配列の指定位置へ読み出します。 このメソッドは指定された数の文字の読み出しを完了するか、ストリームが終端に達するかあるいは例外が throw されるまでブロックします。

定義:

クラス Reader 内の read

パラメータ:

data - 読み出した文字列を書き込む char 配列を渡します。

index - 読み出した文字列を書き込み開始する char 配列の位置を渡します。

length - 読み出す文字数を渡します。

戻り値:

読み出した文字数あるいは -1 を返します。

例外:

IOException - 初回の文字読み出しがストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

NullPointerException - data に null が渡された場合に throw します。

IndexOutOfBoundsException - index が負数あるいは index + length が data のサイズを超える場合に throw します。

関連項目:

OutputStreamWriter.write(char[], int, int)

skip

public long skip(long length)
          throws IOException

ストリームから指定された数の文字を読み飛ばします。 しかし、実際に読み飛ばすことのできる文字数がさまざまな要因（ストリームが終端に達するなど）によって指定された文字数に達しないこともあります。 戻り値には実際に読み飛ばした文字数を返します。

オーバーライド:

クラス Reader 内の skip

パラメータ:

length - 読み飛ばす文字数を渡します。

例外:

IOException - ストリームが終端に達した以外の要因で読み出しに失敗した場合に throw します。

ready

public boolean ready()
              throws IOException

ストリームから文字をブロックせずに読み出せるか否かを返します。

オーバーライド:

クラス Reader 内の ready

戻り値:

ブロックせずに読み出すことができる場合は true を、そうではない場合は false を返します。

例外:

IOException - 判定を行う際に何らかの障害が発生した場合に throw します。

markSupported

public boolean markSupported()

ストリームが mark(int) メソッドと reset() メソッドによる操作に対応しているか否かを返します。

オーバーライド:

クラス Reader 内の markSupported

戻り値:

入力ストリームが mark(int) メソッドと reset() メソッドによる操作をサポートしている場合は true を、サポートしていない場合は false を返します。

関連項目:

mark(int), reset()

mark

public void mark(int size)
          throws IOException

ストリームが指している現在位置をマークします。 reset() メソッドを呼び出すと入力ストリームが次回文字を取り出す位置がマークした位置へ戻ります。 これにより、ストリームの特定部分を繰り返し読むことができます。

オーバーライド:

クラス Reader 内の mark

パラメータ:

size - 現在位置をマークしてから読み出される可能性のある最大バイト数を渡します。

例外:

IOException - ストリームがこのメソッドをサポートしない場合あるいは処理上何らかの障害が発生した場合に throw します。

reset

public void reset()
           throws IOException

ストリームが次回文字を読み出す位置を、最後に mark(int) メソッドによってマークした位置あるいは実装に固有な規定位置に戻します。

オーバーライド:

クラス Reader 内の reset

例外:

IOException - マークされた位置が無効となっている場合あるいはこのメソッドの操作をサポートしていない場合に throw します。

関連項目:

markSupported(), mark(int)

close

public void close()
           throws IOException

ストリームをクローズし、関連するリソースを全て開放します。

定義:

クラス Reader 内の close

例外:

IOException - 処理に伴い、入力関係で何らかの障害が発生した場合に throw します。