com.orangesignal.jlha.DisconnectableInputStream Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of orangesignal-csv Show documentation
Show all versions of orangesignal-csv Show documentation
OrangeSignal CSV is a very flexible csv (comma-separated values) read and write library for Java.
The newest version!
/**
* Copyright (C) 2001-2002 Michel Ishizuka All rights reserved.
*
* 以下の条件に同意するならばソースとバイナリ形式の再配布と使用を
* 変更の有無にかかわらず許可する。
*
* １．ソースコードの再配布において著作権表示と この条件のリスト
* および下記の声明文を保持しなくてはならない。
*
* ２．バイナリ形式の再配布において著作権表示と この条件のリスト
* および下記の声明文を使用説明書もしくは その他の配布物内に
* 含む資料に記述しなければならない。
*
* このソフトウェアは石塚美珠瑠によって無保証で提供され、特定の目
* 的を達成できるという保証、商品価値が有るという保証にとどまらず、
* いかなる明示的および暗示的な保証もしない。
* 石塚美珠瑠は このソフトウェアの使用による直接的、間接的、偶発
* 的、特殊な、典型的な、あるいは必然的な損害(使用によるデータの
* 損失、業務の中断や見込まれていた利益の遺失、代替製品もしくは
* サービスの導入費等が考えられるが、決してそれだけに限定されない
* 損害)に対して、いかなる事態の原因となったとしても、契約上の責
* 任や無過失責任を含む いかなる責任があろうとも、たとえそれが不
* 正行為のためであったとしても、またはそのような損害の可能性が報
* 告されていたとしても一切の責任を負わないものとする。
*/
package com.orangesignal.jlha;
import java.io.IOException;
import java.io.InputStream;
/**
* データを供給する入力ストリームと データを処理する 入力ストリームとの接続を解除するためのユーティリティクラス。
* 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]
* タブ廃止
* ライセンス文の修正
* ソース整備
*
*
*
* @author $Author: dangan $
* @version $Revision: 1.0 $
*/
public class DisconnectableInputStream extends InputStream implements Disconnectable {
/**
* 接続された入力ストリーム
*/
private InputStream in;
// ------------------------------------------------------------------
// Constructer
/**
* in との接続を解除可能な入力ストリームを構築する。
*
* @param in 入力ストリーム
*/
public DisconnectableInputStream(final InputStream in) {
if (in != null) {
this.in = in;
} else {
throw new NullPointerException("in");
}
}
// ------------------------------------------------------------------
// java.io.InputStream methods
/**
* 接続された入力ストリームから 次の1バイトのデータを得る。
*
* @return 読み込まれた1バイトのデータ。
* EndOfStreamに達した場合は -1 を返す。
*
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public int read() throws IOException {
return in.read(); // throws IOException
}
/**
* 接続された入力ストリームから バイト配列 buffer を 満たすようにデータを読み込む。
* データは必ずしも buffer を満たすとは限らないことに注意。
*
* @param buffer 読み込まれたデータを格納するためのバイト配列
* @return buffer に読み込んだデータ量をバイト数で返す。
* 既に EndOfStream に達していた場合は -1 を返す。
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public int read(final byte[] buffer) throws IOException {
return in.read(buffer, 0, buffer.length); // throws IOException
}
/**
* 接続された入力ストリームから バイト配列 buffer の index で指定された位置から length バイトのデータを 読み込む。
* データは必ずしも length バイト読み込まれるとは限ら ないことに注意。
*
* @param buffer 読み込まれたデータを格納するためのバイト配列
* @param index buffer内のデータ読み込み開始位置
* @param length bufferに読み込むデータ量
* @return buffer に読み込んだデータ量をバイト数で返す。
* 既に EndOfStream に達していた場合は -1 を返す。
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public int read(final byte[] buffer, final int index, final int length) throws IOException {
if (0 < length) {
return in.read(buffer, index, length); // throws IOException
}
return 0;
}
/**
* 接続された入力ストリームのデータを length バイト 読み飛ばす。
*
* @param length 読み飛ばすバイト数。
* @return 実際に読み飛ばされたバイト数。
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public long skip(final long length) throws IOException {
if (0 < length) {
return in.skip(length); // throws IOException
}
return 0;
}
// ------------------------------------------------------------------
// method of java.io.InputStream
/**
* 接続された入力ストリームの現在位置にマークを設定し、 reset() メソッドでマークした時点の 読み込み位置に 戻れるようにする。
*
* @param readLimit マーク位置に戻れる限界のバイト数。 このバイト数を超えてデータを読み 込んだ場合 reset()できなくなる可 能性がある。
*/
@Override
public void mark(final int readLimit) {
in.mark(readLimit);
}
/**
* 接続された入力ストリームの読み込み位置を最後に mark() メソッドが呼び出されたときの位置に設定する。
*
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public void reset() throws IOException {
in.reset(); // throws IOException
}
/**
* 接続された入力ストリームが mark() と reset() を サポートするかを得る。
*
* @return ストリームが mark() と reset() を サポートする場合は true。
* サポートしない場合は false。
*/
public boolean markSupprted() {
return in.markSupported();
}
// ------------------------------------------------------------------
// method of java.io.InputStream
/**
* 接続された入力ストリームからブロックしないで 読み込むことのできるバイト数を得る。
*
* @return ブロックしないで読み出せるバイト数。
*
* @exception IOException 入出力エラーが発生した場合
*/
@Override
public int available() throws IOException {
return in.available(); // throws IOException
}
/**
* 接続された入力ストリームとの接続を解除する。
* このメソッドは disconnect() を呼ぶだけである。
*/
@Override
public void close() {
disconnect();
}
// ------------------------------------------------------------------
// method of jp.gr.java_conf.dangan.io.Disconnectable
/**
* 接続された入力ストリームとの接続を解除する。
*/
@Override
public void disconnect() {
in = null;
}
}