クラスBufferedInputStream

java.lang.Object
java.io.InputStream
java.io.FilterInputStream
java.io.BufferedInputStream
すべての実装されたインタフェース:
Closeable, AutoCloseable
public class BufferedInputStream extends FilterInputStream
BufferedInputStreamは、ほかの入力ストリームに機能、特に入力をバッファに格納する機能とmarkおよびresetメソッドをサポートする機能を追加します。 BufferedInputStreamが作成されると、内部バッファ配列が作成されます。 ストリームのバイトが読み込まれるかスキップされると、格納されている入力ストリームから必要に応じて一度に多数のバイトが内部バッファに補充されます。 markオペレーションは入力ストリームの特定位置を記憶します。resetオペレーションは、格納されている入力ストリームから新しいバイトが取得される前に、最後に実行されたmarkオペレーション以降に読み込まれたすべてのバイトを再読込みします。
APIのノート:
BufferedInputStreamにラップした後は、基礎となるInputStreamを直接使用したり、別のストリームでラップしたりしないでください。
導入されたバージョン:
1.0

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected byte[]
    buf
    データを格納する内部バッファ配列です。
    protected int
    count
    バッファ中の最後の有効バイト・インデックスよりも1つ大きな数値を持つインデックスです。
    protected int
    marklimit
    markメソッドが呼び出され、かつ、後続のresetメソッドの呼出しが失敗する前の状態で先読み可能な最大数です。
    protected int
    markpos
    最後にmarkメソッドが呼び出されたときのposフィールドの値です。
    protected int
    pos
    バッファ内の現在位置です。

    クラスjava.io.FilterInputStreamで宣言されたフィールド

    in

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

    コンストラクタ
    コンストラクタ
    説明
    BufferedInputStream(InputStream in)
    BufferedInputStreamを作成し、その引数である入力ストリームinをあとで使用できるように保存します。
    BufferedInputStream(InputStream in, int size)
    指定されたバッファ・サイズを持つBufferedInputStreamを作成し、その引数である入力ストリームinをあとで使用できるように保存します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    int
    available()
    この入力ストリームのメソッドの次の呼出しによって、ブロックせずにこの入力ストリームから読み込むことができる(またはスキップできる)推定バイト数を返します。
    void
    close()
    この入力ストリームを閉じて、そのストリームに関連するすべてのシステム・リソースを解放します。
    void
    mark(int readlimit)
    InputStreamのmarkメソッドの汎用規約を参照してください。
    boolean
    markSupported()
    この入力ストリームがmarkおよびresetメソッドをサポートしているかどうかを判定します。
    int
    read()
    InputStreamのreadメソッドの汎用規約を参照してください。
    int
    read(byte[] b, int off, int len)
    このバイト入力ストリームからバイトを読み取って、指定されたバイト配列に指定のオフセットから挿入します。
    void
    reset()
    InputStreamのresetメソッドの汎用規約を参照してください。
    long
    skip(long n)
    InputStreamのskipメソッドの汎用規約を参照してください。

    クラスjava.io.FilterInputStreamで宣言されたメソッド

    read

    クラスjava.io.InputStreamで宣言されたメソッド

    nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

    クラスjava.lang.Objectで宣言されたメソッド

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

  • フィールド詳細

    • buf

      protected volatile byte[] buf
      データを格納する内部バッファ配列です。 必要に応じて、異なるサイズのほかの配列で置き換えられます。

    • count

      protected int count
      バッファ中の最後の有効バイト・インデックスよりも1つ大きな数値を持つインデックスです。 この値の範囲は、常に0からbuf.lengthです。要素buf[0]からbuf[count-1] には、ベースとなる入力ストリームから取得されたバッファリングされた入力データが格納されます。

    • pos

      protected int pos
      バッファ内の現在位置です。 これは、buf配列から読み取られる次のバイトのインデックスです。

      この値の範囲は、常に0からcountです。 この値がcountより小さい場合、入力される次のバイトはbuf[pos]です。countに等しい場合、次のreadオペレーションまたはskipオペレーションは格納されている入力ストリームからこれ以降のバイトを読み込む必要があります。

      関連項目:

    • markpos

      protected int markpos
      最後にmarkメソッドが呼び出されたときのposフィールドの値です。

      この値の範囲は、常に-1からposです。 入力ストリームにマーク位置がない場合、このフィールドは-1です。 入力ストリームにマーク位置がある場合、resetオペレーションの実行後に入力される最初のバイトはbuf[markpos]です。 markposが-1ではない場合、buf[markpos]からbuf[pos-1]の位置にあるすべてのバイトはバッファ配列に残っていなければいけません(ただし、count、pos、markposの値に適切な調整を施せば、バッファ配列内の別の位置に移動できる)。posとmarkposの差がmarklimitを超えないかぎり、これらのバイトは破棄されません。

      関連項目:

    • marklimit

      protected int marklimit
      markメソッドが呼び出され、かつ、後続のresetメソッドの呼出しが失敗する前の状態で先読み可能な最大数です。 posとmarkposの差がmarklimitを超えると、markposが-1に設定され、マークは破棄されます。
      関連項目:

  • コンストラクタの詳細

    • BufferedInputStream

      public BufferedInputStream(InputStream in)
      BufferedInputStreamを作成し、その引数である入力ストリームinをあとで使用できるように保存します。 内部バッファ配列が作成され、bufに格納されます。
      パラメータ:
      in - ベースとなる入力ストリーム。

    • BufferedInputStream

      public BufferedInputStream(InputStream in, int size)
      指定されたバッファ・サイズを持つBufferedInputStreamを作成し、その引数である入力ストリームinをあとで使用できるように保存します。 長さsizeの内部バッファ配列が作成され、bufに格納されます。
      パラメータ:
      in - ベースとなる入力ストリーム。
      size - バッファ・サイズ。
      スロー:
      IllegalArgumentException - size <= 0の場合

  • メソッドの詳細

    • read

      public int read() throws IOException
      InputStreamのreadメソッドの汎用規約を参照してください。
      オーバーライド:
      read、クラスFilterInputStream
      戻り値:
      データの次のバイト。ストリームの終わりに達した場合は-1。
      スロー:
      IOException - この入力ストリームがそのclose()メソッドの呼出しによって閉じられた場合、または入出力エラーが発生した場合。
      関連項目:

    • read

      public int read(byte[] b, int off, int len) throws IOException
      このバイト入力ストリームからバイトを読み取って、指定されたバイト配列に指定のオフセットから挿入します。

      このメソッドは、InputStreamクラスの対応するreadメソッドの汎用縮小を実装します。 より高い利便性のため、このメソッドはベースとなるストリームのreadメソッドを繰返し呼び出して、できるだけ多くのバイト数を読み込もうとします。 このreadの反復は、次の条件の1つがtrueになるまで行われます。

      • 指定されたバイト数が読み込まれた。
      • ベースとなるストリームのreadメソッドが、ファイルの終わりを示す-1を返した。
      • ベースとなるストリームのavailableメソッドが、それ以上の入力要求がブロックされることを示すゼロを返した。
      ベースとなるストリームの最初のreadがファイルの終わりを示す-1を返すと、このメソッドは-1を返します。 それ以外の場合、このメソッドは実際に読み取られたバイト数を返します。

      このクラスのサブクラスは、同じ方法でできるだけ多くのバイト数を読み込むことが推奨されます。ただし、これは必須ではありません。

      オーバーライド:
      read、クラスFilterInputStream
      パラメータ:
      b - 転送先バッファ。
      off - バイトの格納開始オフセット。
      len - 読み込むバイトの最大数。
      戻り値:
      読み込まれるバイト数。ストリームの終わりに達した場合は-1。
      スロー:
      IOException - この入力ストリームがそのclose()メソッドの呼出しによって閉じられた場合、または入出力エラーが発生した場合。
      IndexOutOfBoundsException - offが負の値の場合、lenが負の値の場合、あるいはlenがb.length - offより大きい場合
      関連項目:

    • skip

      public long skip(long n) throws IOException
      InputStreamのskipメソッドの汎用規約を参照してください。
      オーバーライド:
      skip、クラスFilterInputStream
      パラメータ:
      n - スキップされるバイト数。
      戻り値:
      実際にスキップされたバイト数。
      スロー:
      IOException - この入力ストリームがclose()メソッドを呼び出して閉じられた場合、in.skip(n)はIOExceptionをスローするか、I/Oエラーが発生します。
      関連項目:

    • available

      public int available() throws IOException
      この入力ストリームのメソッドの次の呼出しによって、ブロックせずにこの入力ストリームから読み込むことができる(またはスキップできる)推定バイト数を返します。 次の呼出しは、同じスレッドの場合も別のスレッドの場合もあります。 このような多数のバイトを1回で読み込んだりスキップしたりすることでブロックすることはありませんが、読み込むまたはスキップするバイト数が少なくなることがあります。

      このメソッドは、バッファ(count - pos)で読み取られる残りのバイト数の合計と、in.available()のコール結果を戻します。

      オーバーライド:
      available、クラスFilterInputStream
      戻り値:
      ブロックせずにこの入力ストリームから読み込むことができる(またはスキップできる)推定バイト数。
      スロー:
      IOException - この入力ストリームがそのclose()メソッドの呼出しによって閉じられた場合、または入出力エラーが発生した場合。

    • mark

      public void mark(int readlimit)
      InputStreamのmarkメソッドの汎用規約を参照してください。
      オーバーライド:
      mark、クラスFilterInputStream
      パラメータ:
      readlimit - マーク位置が無効になる前に読込み可能なバイト数の上限。
      関連項目:

    • reset

      public void reset() throws IOException
      InputStreamのresetメソッドの汎用規約を参照してください。

      markposが-1である(マークが設定されていないか、マークが無効になっている)場合、IOExceptionがスローされます。 そうでない場合、posはmarkposに一致するように設定されます。

      オーバーライド:
      reset、クラスFilterInputStream
      スロー:
      IOException - このストリームにマークが付いていない場合、マークが無効な場合、ストリームがclose()メソッドの呼出しによって閉じられた場合、または入出力エラーが発生した場合。
      関連項目:

    • markSupported

      public boolean markSupported()
      この入力ストリームがmarkおよびresetメソッドをサポートしているかどうかを判定します。 BufferedInputStreamのmarkSupportedメソッドはtrueを返します。
      オーバーライド:
      markSupported、クラスFilterInputStream
      戻り値:
      このストリームの型がmarkおよびresetメソッドをサポートしているかどうかを示すboolean。
      関連項目:

    • close

      public void close() throws IOException
      この入力ストリームを閉じて、そのストリームに関連するすべてのシステム・リソースを解放します。 ストリームを閉じたあとに、さらにread()、available()、reset()、またはskip()を呼び出すと、IOExceptionがスローされます。 すでに閉じられているストリームを閉じても、何の影響もありません。
      定義:
      close、インタフェースAutoCloseable
      定義:
      close、インタフェースCloseable
      オーバーライド:
      close、クラスFilterInputStream
      スロー:
      IOException - 入出力エラーが発生した場合。
      関連項目: