javax.servlet
クラス ServletInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--javax.servlet.ServletInputStream

public abstract class ServletInputStream

extends InputStream

クライアントが送って来たリクエストからバイナリデータを読み取る入力ストリームを提供しますが、 ここには一行ずつデータを読むのに便利な readLine() メソッドもあります。HTTP POST や PUT などのいくつかのプロトコルではクライアントが送って来たデータを読むのに ServletInputStream オブジェクトを使います。

ServletInputStream オブジェクトは通常 ServletRequest.getInputStream() メソッドから取得します。

このクラスは抽象クラスとなっていますが、実装は Servlet コンテナが提供します。 このクラスのサブクラスは java.io.InputStream.read() メソッドを実装しなければなりません。

バージョン:

$Version$

作成者:

Various

関連項目:

ServletRequest

コンストラクタの概要

protected

ServletInputStream() 抽象クラスのため、何も実行しません。

メソッドの概要

int	readLine(byte[] b, int off, int len) 入力ストリームから一行ずつ読み込みます。

クラス java.io.InputStream から継承したメソッド

available, close, mark, markSupported, read, read, read, reset, skip

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

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

コンストラクタの詳細

ServletInputStream

protected ServletInputStream()

抽象クラスのため、何も実行しません。

メソッドの詳細

readLine

public int readLine(byte[] b,
                    int off,
                    int len)
             throws IOException

入力ストリームから一行ずつ読み込みます。指定のオフセットから開始し、 byte 配列に読み込みます。指定されたバイト数分読み込むか、 改行文字に達したときに終了します。改行文字も他のバイトデータ同様、 配列に読み込まれます。

このメソッドは入力ストリームが終了するまでに、 指定された byte 数分のデータを読み込めなかった場合、 -1 を返します。

パラメータ:

b - 読み込んだデータを格納する byte の配列

off - このメソッドが、どの文字から読み込みを開始するかを指定する整数

len - 一度に読み込む最大バイト数を指定する整数

戻り値:

実際に読み込んだバイト数を表す整数。 ストリームの最後まで達した場合は -1

例外:

IOException - 入出力の例外が発生したとき