jp.gr.java_conf.dangan.io
Class DisconnectableInputStream

java.lang.Object
  java.io.InputStream
      jp.gr.java_conf.dangan.io.DisconnectableInputStream

All Implemented Interfaces:

java.io.Closeable, Disconnectable

public class DisconnectableInputStream
extends java.io.InputStream
implements Disconnectable

データを供給する入力ストリームと データを処理する 入力ストリームとの接続を解除するためのユーティリティクラス。
java.io.BufferedInputStream 等のバッファリングするストリーム との接続を解除する場合は jp.gr.java_conf.dangan.io.LimitedInputStream 等を使用して 接続解除位置を過ぎたバッファリングを抑止する必要がある。

 -- revision history --
 $Log: DisconnectableInputStream.java,v $
 Revision 1.0  2002/07/24 00:00:00  dangan
 add to version control
 [maintenance]
     タブ廃止
     ライセンス文の修正
     ソース整備

 

Version:

$Revision: 1.0 $

Author:

$Author: dangan $

Constructor Summary

DisconnectableInputStream(java.io.InputStream in)
in との接続を解除可能な入力ストリームを構築する。

Method Summary

int	available() 接続された入力ストリームからブロックしないで 読み込むことのできるバイト数を得る。
void	close() 接続された入力ストリームとの接続を解除する。 このメソッドは disconnect() を呼ぶだけである。
void	disconnect() 接続された入力ストリームとの接続を解除する。
void	mark(int readLimit) 接続された入力ストリームの現在位置にマークを設定し、 reset() メソッドでマークした時点の 読み込み位置に 戻れるようにする。
boolean	markSupprted() 接続された入力ストリームが mark() と reset() を サポートするかを得る。
int	read() 接続された入力ストリームから 次の1バイトのデータを得る。
int	read(byte[] buffer) 接続された入力ストリームから バイト配列 buffer を 満たすようにデータを読み込む。 データは必ずしも buffer を満たすとは限らないことに注意。
int	read(byte[] buffer, int index, int length) 接続された入力ストリームから バイト配列 buffer の index で指定された位置から length バイトのデータを 読み込む。 データは必ずしも length バイト読み込まれるとは限ら ないことに注意。
void	reset() 接続された入力ストリームの読み込み位置を最後に mark() メソッドが呼び出されたときの位置に設定する。
long	skip(long length) 接続された入力ストリームのデータを length バイト 読み飛ばす。

Methods inherited from class java.io.InputStream

markSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

DisconnectableInputStream

public DisconnectableInputStream(java.io.InputStream in)

in との接続を解除可能な入力ストリームを構築する。

Parameters:

in - 入力ストリーム

Method Detail

read

public int read()
         throws java.io.IOException

接続された入力ストリームから 次の1バイトのデータを得る。

Specified by:

read in class java.io.InputStream

Returns:

読み込まれた1バイトのデータ。
EndOfStreamに達した場合は -1 を返す。

Throws:

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

read

public int read(byte[] buffer)
         throws java.io.IOException

接続された入力ストリームから バイト配列 buffer を 満たすようにデータを読み込む。
データは必ずしも buffer を満たすとは限らないことに注意。

Overrides:

read in class java.io.InputStream

Parameters:

buffer - 読み込まれたデータを格納するためのバイト配列

Returns:

buffer に読み込んだデータ量をバイト数で返す。
既に EndOfStream に達していた場合は -1 を返す。

Throws:

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

read

public int read(byte[] buffer,
                int index,
                int length)
         throws java.io.IOException

接続された入力ストリームから バイト配列 buffer の index で指定された位置から length バイトのデータを 読み込む。
データは必ずしも length バイト読み込まれるとは限ら ないことに注意。

Overrides:

read in class java.io.InputStream

Parameters:

buffer - 読み込まれたデータを格納するためのバイト配列

index - buffer内のデータ読み込み開始位置

length - bufferに読み込むデータ量

Returns:

buffer に読み込んだデータ量をバイト数で返す。
既に EndOfStream に達していた場合は -1 を返す。

Throws:

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

skip

public long skip(long length)
          throws java.io.IOException

接続された入力ストリームのデータを length バイト 読み飛ばす。

Overrides:

skip in class java.io.InputStream

Parameters:

length - 読み飛ばすバイト数。

Returns:

実際に読み飛ばされたバイト数。

Throws:

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

mark

public void mark(int readLimit)

接続された入力ストリームの現在位置にマークを設定し、 reset() メソッドでマークした時点の 読み込み位置に 戻れるようにする。

Overrides:

mark in class java.io.InputStream

Parameters:

readLimit - マーク位置に戻れる限界のバイト数。 このバイト数を超えてデータを読み 込んだ場合 reset()できなくなる可 能性がある。

reset

public void reset()
           throws java.io.IOException

接続された入力ストリームの読み込み位置を最後に mark() メソッドが呼び出されたときの位置に設定する。

Overrides:

reset in class java.io.InputStream

Throws:

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

markSupprted

public boolean markSupprted()

接続された入力ストリームが mark() と reset() を サポートするかを得る。

Returns:

ストリームが mark() と reset() を サポートする場合は true。
サポートしない場合は false。

available

public int available()
              throws java.io.IOException

接続された入力ストリームからブロックしないで 読み込むことのできるバイト数を得る。

Overrides:

available in class java.io.InputStream

Returns:

ブロックしないで読み出せるバイト数。

Throws:

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

close

public void close()

接続された入力ストリームとの接続を解除する。
このメソッドは disconnect() を呼ぶだけである。

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.InputStream

disconnect

public void disconnect()

接続された入力ストリームとの接続を解除する。

Specified by:

disconnect in interface Disconnectable